@d19n/youfibre-odin-sdk 2.0.342 → 2.0.344

package/dist/db-sdk-v2/OrderDb.d.ts

@@ -63,6 +63,7 @@ export declare class OrderDb extends DbProvider {
     private _dataissue?;
     private _workorder?;
     private _email?;
+    private _commitment?;
     constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
     get note(): DbRecordLinkManager;
     get lead(): DbRecordLinkManager;
@@ -106,6 +107,7 @@ export declare class OrderDb extends DbProvider {
     get dataissue(): DbRecordLinkManager;
     get workorder(): DbRecordLinkManager;
     get email(): DbRecordLinkManager;
+    get commitment(): DbRecordLinkManager;
     setRecord(sourceRecord: any): void;
     /**
      * Search records with manual pagination control

package/dist/db-sdk-v2/OrderDb.js

@@ -290,6 +290,12 @@ class OrderDb extends db_provider_1.DbProvider {
         }
         return this._email;
     }
+    get commitment() {
+        if (!this._commitment) {
+            this._commitment = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'OrderModule:Order', 'OrderModule:Commitment', 'Commitment__Order');
+        }
+        return this._commitment;
+    }
     // ============================================
     // STANDARD METHODS
     // ============================================

package/dist/entities-v2/AiRouteRequest.d.ts

@@ -26,16 +26,24 @@ export declare enum AiRouteRequestEntityTypes {
  * @remarks Available options:
  * - `CASE_SENTIMENT`
  * - `CASE_TAGGING`
+ * - `CBO_FINAL_BILL_CHECK`
  * - `CHAT_SUMMARY`
  * - `CUSTOMER_CONTEXT_SUMMARY`
+ * - `DOCUMENT_DESCRIBE`
+ * - `EDGAR_CHAT`
+ * - `INSTALL_FORM_REVIEW`
  * - `MAGRATHEA_PORTING`
  * - `QA_REPORT`
  */
 export declare enum AiRouteRequestFeature {
     CASE_SENTIMENT = "CASE_SENTIMENT",
     CASE_TAGGING = "CASE_TAGGING",
+    CBO_FINAL_BILL_CHECK = "CBO_FINAL_BILL_CHECK",
     CHAT_SUMMARY = "CHAT_SUMMARY",
     CUSTOMER_CONTEXT_SUMMARY = "CUSTOMER_CONTEXT_SUMMARY",
+    DOCUMENT_DESCRIBE = "DOCUMENT_DESCRIBE",
+    EDGAR_CHAT = "EDGAR_CHAT",
+    INSTALL_FORM_REVIEW = "INSTALL_FORM_REVIEW",
     MAGRATHEA_PORTING = "MAGRATHEA_PORTING",
     QA_REPORT = "QA_REPORT"
 }
@@ -68,19 +76,23 @@ export declare enum AiRouteRequestOutcome {
 /**
  * Valid values for AiRouteRequest.Reason
  *
- * split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard).
+ * split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). single-provider: the feature has one provider, no split. edgar-reply: a message Edgar AI posted, no call of ours to time.
  *
  * @remarks Available options:
  * - `config-off`
  * - `config-unreadable`
+ * - `edgar-reply`
  * - `redis-unavailable`
+ * - `single-provider`
  * - `split`
  * - `too-large`
  */
 export declare enum AiRouteRequestReason {
     CONFIG_OFF = "config-off",
     CONFIG_UNREADABLE = "config-unreadable",
+    EDGAR_REPLY = "edgar-reply",
     REDIS_UNAVAILABLE = "redis-unavailable",
+    SINGLE_PROVIDER = "single-provider",
     SPLIT = "split",
     TOO_LARGE = "too-large"
 }
@@ -95,8 +107,6 @@ export declare enum AiRouteRequestPropertyKeys {
     Provider = "Provider",
     /** ok when the provider answered and the reply passed its check; failed after the last try. */
     Outcome = "Outcome",
-    /** split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). */
-    Reason = "Reason",
     /** The per-feature counter value this request drew (odd = qwen, even = databricks). Empty when the split was skipped. */
     Count = "Count",
     /** 1 for Databricks; 1 to 6 for Qwen (one try plus up to five retries). */
@@ -116,7 +126,9 @@ export declare enum AiRouteRequestPropertyKeys {
     /** Id of the case or conversation the request was for. Links the row back to the record. */
     JourneyId = "JourneyId",
     /** When the router started the request. The record is written a few hundred milliseconds later. */
-    StartedAt = "StartedAt"
+    StartedAt = "StartedAt",
+    /** split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). single-provider: the feature has one provider, no split. edgar-reply: a message Edgar AI posted, no call of ours to time. */
+    Reason = "Reason"
 }
 /**
  * Properties for AiRouteRequest records
@@ -145,13 +157,6 @@ export interface AiRouteRequestProperties {
      * @enum {AiRouteRequestOutcome}
      */
     Outcome: AiRouteRequestOutcome;
-    /** split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard).
-     *
-     * @type {ENUM}
-     * @default
-     * @enum {AiRouteRequestReason}
-     */
-    Reason: AiRouteRequestReason;
     /** The per-feature counter value this request drew (odd = qwen, even = databricks). Empty when the split was skipped.
      *
      * @type {NUMBER}
@@ -212,6 +217,13 @@ export interface AiRouteRequestProperties {
      * @default
      */
     StartedAt: string;
+    /** split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). single-provider: the feature has one provider, no split. edgar-reply: a message Edgar AI posted, no call of ours to time.
+     *
+     * @type {ENUM}
+     * @default
+     * @enum {AiRouteRequestReason}
+     */
+    Reason: AiRouteRequestReason;
 }
 /**
  * AiRouteRequest entity from SupportModule

package/dist/entities-v2/AiRouteRequest.js

@@ -30,8 +30,12 @@ var AiRouteRequestEntityTypes;
  * @remarks Available options:
  * - `CASE_SENTIMENT`
  * - `CASE_TAGGING`
+ * - `CBO_FINAL_BILL_CHECK`
  * - `CHAT_SUMMARY`
  * - `CUSTOMER_CONTEXT_SUMMARY`
+ * - `DOCUMENT_DESCRIBE`
+ * - `EDGAR_CHAT`
+ * - `INSTALL_FORM_REVIEW`
  * - `MAGRATHEA_PORTING`
  * - `QA_REPORT`
  */
@@ -39,8 +43,12 @@ var AiRouteRequestFeature;
 (function (AiRouteRequestFeature) {
     AiRouteRequestFeature["CASE_SENTIMENT"] = "CASE_SENTIMENT";
     AiRouteRequestFeature["CASE_TAGGING"] = "CASE_TAGGING";
+    AiRouteRequestFeature["CBO_FINAL_BILL_CHECK"] = "CBO_FINAL_BILL_CHECK";
     AiRouteRequestFeature["CHAT_SUMMARY"] = "CHAT_SUMMARY";
     AiRouteRequestFeature["CUSTOMER_CONTEXT_SUMMARY"] = "CUSTOMER_CONTEXT_SUMMARY";
+    AiRouteRequestFeature["DOCUMENT_DESCRIBE"] = "DOCUMENT_DESCRIBE";
+    AiRouteRequestFeature["EDGAR_CHAT"] = "EDGAR_CHAT";
+    AiRouteRequestFeature["INSTALL_FORM_REVIEW"] = "INSTALL_FORM_REVIEW";
     AiRouteRequestFeature["MAGRATHEA_PORTING"] = "MAGRATHEA_PORTING";
     AiRouteRequestFeature["QA_REPORT"] = "QA_REPORT";
 })(AiRouteRequestFeature = exports.AiRouteRequestFeature || (exports.AiRouteRequestFeature = {}));
@@ -75,12 +83,14 @@ var AiRouteRequestOutcome;
 /**
  * Valid values for AiRouteRequest.Reason
  *
- * split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard).
+ * split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). single-provider: the feature has one provider, no split. edgar-reply: a message Edgar AI posted, no call of ours to time.
  *
  * @remarks Available options:
  * - `config-off`
  * - `config-unreadable`
+ * - `edgar-reply`
  * - `redis-unavailable`
+ * - `single-provider`
  * - `split`
  * - `too-large`
  */
@@ -88,7 +98,9 @@ var AiRouteRequestReason;
 (function (AiRouteRequestReason) {
     AiRouteRequestReason["CONFIG_OFF"] = "config-off";
     AiRouteRequestReason["CONFIG_UNREADABLE"] = "config-unreadable";
+    AiRouteRequestReason["EDGAR_REPLY"] = "edgar-reply";
     AiRouteRequestReason["REDIS_UNAVAILABLE"] = "redis-unavailable";
+    AiRouteRequestReason["SINGLE_PROVIDER"] = "single-provider";
     AiRouteRequestReason["SPLIT"] = "split";
     AiRouteRequestReason["TOO_LARGE"] = "too-large";
 })(AiRouteRequestReason = exports.AiRouteRequestReason || (exports.AiRouteRequestReason = {}));
@@ -104,8 +116,6 @@ var AiRouteRequestPropertyKeys;
     AiRouteRequestPropertyKeys["Provider"] = "Provider";
     /** ok when the provider answered and the reply passed its check; failed after the last try. */
     AiRouteRequestPropertyKeys["Outcome"] = "Outcome";
-    /** split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). */
-    AiRouteRequestPropertyKeys["Reason"] = "Reason";
     /** The per-feature counter value this request drew (odd = qwen, even = databricks). Empty when the split was skipped. */
     AiRouteRequestPropertyKeys["Count"] = "Count";
     /** 1 for Databricks; 1 to 6 for Qwen (one try plus up to five retries). */
@@ -126,6 +136,8 @@ var AiRouteRequestPropertyKeys;
     AiRouteRequestPropertyKeys["JourneyId"] = "JourneyId";
     /** When the router started the request. The record is written a few hundred milliseconds later. */
     AiRouteRequestPropertyKeys["StartedAt"] = "StartedAt";
+    /** split: the 50/50 counter chose. Otherwise why the split was skipped and Databricks answered: config-off, config-unreadable, redis-unavailable, too-large (prompt over the Qwen size guard). single-provider: the feature has one provider, no split. edgar-reply: a message Edgar AI posted, no call of ours to time. */
+    AiRouteRequestPropertyKeys["Reason"] = "Reason";
 })(AiRouteRequestPropertyKeys = exports.AiRouteRequestPropertyKeys || (exports.AiRouteRequestPropertyKeys = {}));
 /**
  * AiRouteRequest entity from SupportModule

package/dist/entities-v2/Commitment.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Commitment Entity Definition
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
+import { OrderProperties } from './Order';
+/**
+ * Available types for Commitment records
+ */
+export declare enum CommitmentEntityTypes {
+    /** This is the default record type */
+    DEFAULT = "DEFAULT"
+}
+/**
+ * Pipeline stage names for DEFAULT Commitment
+ * Pipeline: Commitment
+ * What an order owes, from not-yet-owed through to settled.
+ */
+export declare enum DefaultCommitmentStageNames {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. (default) */
+    NotYetDue = "Not Yet Due",
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    Pending = "Pending",
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    Breached = "Breached",
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    Complete = "Complete",
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    NotRequired = "Not Required"
+}
+/**
+ * Pipeline stage keys for DEFAULT Commitment
+ * Use these keys when transitioning between stages
+ */
+export declare enum DefaultCommitmentStageKeys {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. */
+    CommitmentStageNotYetDue = "CommitmentStageNotYetDue",
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    CommitmentStagePending = "CommitmentStagePending",
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    CommitmentStageBreached = "CommitmentStageBreached",
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    CommitmentStageComplete = "CommitmentStageComplete",
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    CommitmentStageNotRequired = "CommitmentStageNotRequired"
+}
+/**
+ * Property keys for Commitment
+ * Use these constants instead of string literals for type safety
+ */
+export declare enum CommitmentPropertyKeys {
+    /** orderId::type — the natural key. UNIQUE, and what upsertOnCreate hashes, so the reconciler cannot create a second commitment for something already owed. */
+    Fingerprint = "Fingerprint",
+    /** The invariant's stableId, e.g. yf/ORDER/OrderStageSupply/supply-completed-kci-must-arrive-by-committed-date. Generated into COMMITMENT-CATALOG.json from the BP, so this is an address the rest of the estate already uses rather than a new vocabulary. */
+    Type = "Type",
+    /** When it falls due. Empty only while NOT_YET_DUE — a BREACHED commitment without one would be past a deadline that does not exist, which is a fault in whatever created it. */
+    ExpectedBy = "ExpectedBy",
+    /** The record that settled it, as entity and id — e.g. OrderModule:OrderKci/<id>. Text rather than a typed association per dischargeable entity, so a new commitment type needs no schema change. */
+    CompletedBy = "CompletedBy",
+    /** When it was settled. Together with ExpectedBy this says whether it was late. */
+    CompletedAt = "CompletedAt",
+    /** Why it was never owed, when it resolves that way — e.g. NO_CURRENT_PROVIDER for an order with no switch to trigger. Without this, "not required" is indistinguishable from "nobody looked". */
+    NotRequiredReason = "NotRequiredReason"
+}
+/**
+ * Properties for Commitment records
+ *
+ * @see OrderModule:Commitment
+ */
+export interface CommitmentProperties {
+    /** orderId::type — the natural key. UNIQUE, and what upsertOnCreate hashes, so the reconciler cannot create a second commitment for something already owed.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Fingerprint: string;
+    /** The invariant's stableId, e.g. yf/ORDER/OrderStageSupply/supply-completed-kci-must-arrive-by-committed-date. Generated into COMMITMENT-CATALOG.json from the BP, so this is an address the rest of the estate already uses rather than a new vocabulary.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    Type: string;
+    /** When it falls due. Empty only while NOT_YET_DUE — a BREACHED commitment without one would be past a deadline that does not exist, which is a fault in whatever created it.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    ExpectedBy: string;
+    /** The record that settled it, as entity and id — e.g. OrderModule:OrderKci/<id>. Text rather than a typed association per dischargeable entity, so a new commitment type needs no schema change.
+     *
+     * @type {TEXT}
+     * @default
+     */
+    CompletedBy: string;
+    /** When it was settled. Together with ExpectedBy this says whether it was late.
+     *
+     * @type {DATE_TIME}
+     * @default
+     */
+    CompletedAt: string;
+    /** Why it was never owed, when it resolves that way — e.g. NO_CURRENT_PROVIDER for an order with no switch to trigger. Without this, "not required" is indistinguishable from "nobody looked".
+     *
+     * @type {TEXT}
+     * @default
+     */
+    NotRequiredReason: string;
+}
+/**
+ * Commitment entity from OrderModule
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ * @recordPrefix CMT
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+export declare class Commitment extends OdinRecord<CommitmentProperties> {
+    entity: 'OrderModule:Commitment';
+    type: CommitmentEntityTypes;
+    schemaId: '6961f6fc-9d4b-4913-9677-065e0b67a1ce';
+    properties: CommitmentProperties;
+    /** Linked Order records (Commitment__Order) */
+    Order: OdinLink<LinkedOdinRecord<OrderProperties>>;
+}
+/**
+ * RabbitMQ routing keys for Commitment events
+ */
+export declare const ROUTING_KEY_COMMITMENT_CREATED = "OrderModule.Commitment.SubDbRecordCreated";
+export declare const ROUTING_KEY_COMMITMENT_UPDATED = "OrderModule.Commitment.SubDbRecordUpdated";
+export declare const ROUTING_KEY_COMMITMENT_DELETED = "OrderModule.Commitment.SubDbRecordDeleted";
+/**
+ * Type-specific routing keys for Commitment events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+export declare const ROUTING_KEY_COMMITMENT_DEFAULT_CREATED = "OrderModule.Commitment.DEFAULT.SubDbRecordCreated";
+/** This is the default record type updated */
+export declare const ROUTING_KEY_COMMITMENT_DEFAULT_UPDATED = "OrderModule.Commitment.DEFAULT.SubDbRecordUpdated";
+/** This is the default record type deleted */
+export declare const ROUTING_KEY_COMMITMENT_DEFAULT_DELETED = "OrderModule.Commitment.DEFAULT.SubDbRecordDeleted";
+/** Event: Commitment__Order link created */
+export declare const ROUTING_KEY_LINK_COMMITMENT_ORDER_CREATED = "OrderModule.Commitment.Order.SubDbRecordAssociationCreated";
+/** Event: Commitment__Order link deleted */
+export declare const ROUTING_KEY_LINK_COMMITMENT_ORDER_DELETED = "OrderModule.Commitment.Order.SubDbRecordAssociationDeleted";

package/dist/entities-v2/Commitment.js

@@ -0,0 +1,115 @@
+"use strict";
+/**
+ * Commitment Entity Definition
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ *
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
+ * Generated from Odin schema definition
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_DELETED = exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_CREATED = exports.ROUTING_KEY_COMMITMENT_DEFAULT_DELETED = exports.ROUTING_KEY_COMMITMENT_DEFAULT_UPDATED = exports.ROUTING_KEY_COMMITMENT_DEFAULT_CREATED = exports.ROUTING_KEY_COMMITMENT_DELETED = exports.ROUTING_KEY_COMMITMENT_UPDATED = exports.ROUTING_KEY_COMMITMENT_CREATED = exports.Commitment = exports.CommitmentPropertyKeys = exports.DefaultCommitmentStageKeys = exports.DefaultCommitmentStageNames = exports.CommitmentEntityTypes = void 0;
+const core_1 = require("@d19n/odin-types/dist/core");
+/**
+ * Available types for Commitment records
+ */
+var CommitmentEntityTypes;
+(function (CommitmentEntityTypes) {
+    /** This is the default record type */
+    CommitmentEntityTypes["DEFAULT"] = "DEFAULT";
+})(CommitmentEntityTypes = exports.CommitmentEntityTypes || (exports.CommitmentEntityTypes = {}));
+/**
+ * Pipeline stage names for DEFAULT Commitment
+ * Pipeline: Commitment
+ * What an order owes, from not-yet-owed through to settled.
+ */
+var DefaultCommitmentStageNames;
+(function (DefaultCommitmentStageNames) {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. (default) */
+    DefaultCommitmentStageNames["NotYetDue"] = "Not Yet Due";
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    DefaultCommitmentStageNames["Pending"] = "Pending";
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    DefaultCommitmentStageNames["Breached"] = "Breached";
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    DefaultCommitmentStageNames["Complete"] = "Complete";
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    DefaultCommitmentStageNames["NotRequired"] = "Not Required";
+})(DefaultCommitmentStageNames = exports.DefaultCommitmentStageNames || (exports.DefaultCommitmentStageNames = {}));
+/**
+ * Pipeline stage keys for DEFAULT Commitment
+ * Use these keys when transitioning between stages
+ */
+var DefaultCommitmentStageKeys;
+(function (DefaultCommitmentStageKeys) {
+    /** The precondition has not happened, so there is no clock — not a clock still running. A Supply order before its CommittedDate sits here. */
+    DefaultCommitmentStageKeys["CommitmentStageNotYetDue"] = "CommitmentStageNotYetDue";
+    /** Owed, and the clock is running — ExpectedBy is in the future. */
+    DefaultCommitmentStageKeys["CommitmentStagePending"] = "CommitmentStagePending";
+    /** Owed, ExpectedBy has passed, nothing discharged it. Still open work — it ages. Can still be discharged late, which is how lateness gets measured. */
+    DefaultCommitmentStageKeys["CommitmentStageBreached"] = "CommitmentStageBreached";
+    /** The thing that was owed happened. CompletedBy names the record that did it — a COMPLETED OrderKci, a switch at TRIGGER_CONFIRMED. */
+    DefaultCommitmentStageKeys["CommitmentStageComplete"] = "CommitmentStageComplete";
+    /** Resolved as never owed, with the reason — an order with no switch to trigger. A distinct terminal state from Discharged: nothing happened, rather than the thing happening. */
+    DefaultCommitmentStageKeys["CommitmentStageNotRequired"] = "CommitmentStageNotRequired";
+})(DefaultCommitmentStageKeys = exports.DefaultCommitmentStageKeys || (exports.DefaultCommitmentStageKeys = {}));
+/**
+ * Property keys for Commitment
+ * Use these constants instead of string literals for type safety
+ */
+var CommitmentPropertyKeys;
+(function (CommitmentPropertyKeys) {
+    /** orderId::type — the natural key. UNIQUE, and what upsertOnCreate hashes, so the reconciler cannot create a second commitment for something already owed. */
+    CommitmentPropertyKeys["Fingerprint"] = "Fingerprint";
+    /** The invariant's stableId, e.g. yf/ORDER/OrderStageSupply/supply-completed-kci-must-arrive-by-committed-date. Generated into COMMITMENT-CATALOG.json from the BP, so this is an address the rest of the estate already uses rather than a new vocabulary. */
+    CommitmentPropertyKeys["Type"] = "Type";
+    /** When it falls due. Empty only while NOT_YET_DUE — a BREACHED commitment without one would be past a deadline that does not exist, which is a fault in whatever created it. */
+    CommitmentPropertyKeys["ExpectedBy"] = "ExpectedBy";
+    /** The record that settled it, as entity and id — e.g. OrderModule:OrderKci/<id>. Text rather than a typed association per dischargeable entity, so a new commitment type needs no schema change. */
+    CommitmentPropertyKeys["CompletedBy"] = "CompletedBy";
+    /** When it was settled. Together with ExpectedBy this says whether it was late. */
+    CommitmentPropertyKeys["CompletedAt"] = "CompletedAt";
+    /** Why it was never owed, when it resolves that way — e.g. NO_CURRENT_PROVIDER for an order with no switch to trigger. Without this, "not required" is indistinguishable from "nobody looked". */
+    CommitmentPropertyKeys["NotRequiredReason"] = "NotRequiredReason";
+})(CommitmentPropertyKeys = exports.CommitmentPropertyKeys || (exports.CommitmentPropertyKeys = {}));
+/**
+ * Commitment entity from OrderModule
+ *
+ * One thing an order still owes, and when it falls due: the type, the deadline, what discharged it, and where it stands (Not Yet Due / Pending / Breached / Discharged / Not Required). An order is finished when it has no open commitments.
+ *
+ * @module OrderModule
+ * @entity Commitment
+ * @schemaId 6961f6fc-9d4b-4913-9677-065e0b67a1ce
+ * @recordPrefix CMT
+ * @capabilities searchable, updateable, undeletable, triggerable
+ */
+class Commitment extends core_1.OdinRecord {
+}
+exports.Commitment = Commitment;
+// ============================================
+// RABBITMQ EVENT ROUTING KEYS
+// ============================================
+/**
+ * RabbitMQ routing keys for Commitment events
+ */
+exports.ROUTING_KEY_COMMITMENT_CREATED = 'OrderModule.Commitment.SubDbRecordCreated';
+exports.ROUTING_KEY_COMMITMENT_UPDATED = 'OrderModule.Commitment.SubDbRecordUpdated';
+exports.ROUTING_KEY_COMMITMENT_DELETED = 'OrderModule.Commitment.SubDbRecordDeleted';
+/**
+ * Type-specific routing keys for Commitment events
+ * Subscribe to these for events on specific entity types only
+ */
+/** This is the default record type created */
+exports.ROUTING_KEY_COMMITMENT_DEFAULT_CREATED = 'OrderModule.Commitment.DEFAULT.SubDbRecordCreated';
+/** This is the default record type updated */
+exports.ROUTING_KEY_COMMITMENT_DEFAULT_UPDATED = 'OrderModule.Commitment.DEFAULT.SubDbRecordUpdated';
+/** This is the default record type deleted */
+exports.ROUTING_KEY_COMMITMENT_DEFAULT_DELETED = 'OrderModule.Commitment.DEFAULT.SubDbRecordDeleted';
+/** Event: Commitment__Order link created */
+exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_CREATED = 'OrderModule.Commitment.Order.SubDbRecordAssociationCreated';
+/** Event: Commitment__Order link deleted */
+exports.ROUTING_KEY_LINK_COMMITMENT_ORDER_DELETED = 'OrderModule.Commitment.Order.SubDbRecordAssociationDeleted';

package/dist/entities-v2/ContractBuyOut.d.ts

@@ -19,6 +19,7 @@ import { CaseProperties } from './Case';
 import { UserProperties } from './User';
 import { PaymentMethodRefundProperties } from './PaymentMethodRefund';
 import { ContactProperties } from './Contact';
+import { DocumentProperties } from './Document';
 /**
  * Available types for ContractBuyOut records
  */
@@ -296,6 +297,8 @@ export declare class ContractBuyOut extends OdinRecord<ContractBuyOutProperties>
     PaymentMethodRefund: OdinLink<LinkedOdinRecord<PaymentMethodRefundProperties>>;
     /** Linked Contact records (Contact__ContractBuyOut) */
     Contact: OdinLink<LinkedOdinRecord<ContactProperties>>;
+    /** Linked Document records (ContractBuyOut__Document) */
+    Document: OdinLink<LinkedOdinRecord<DocumentProperties>>;
 }
 /**
  * RabbitMQ routing keys for ContractBuyOut events
@@ -333,3 +336,7 @@ export declare const ROUTING_KEY_LINK_CONTRACT_BUY_OUT_USER_DELETED = "OrderModu
 export declare const ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_CREATED = "OrderModule.ContractBuyOut.PaymentMethodRefund.SubDbRecordAssociationCreated";
 /** Event: ContractBuyOut__PaymentMethodRefund link deleted */
 export declare const ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_DELETED = "OrderModule.ContractBuyOut.PaymentMethodRefund.SubDbRecordAssociationDeleted";
+/** Event: ContractBuyOut__Document link created */
+export declare const ROUTING_KEY_LINK_CONTRACT_BUY_OUT_DOCUMENT_CREATED = "OrderModule.ContractBuyOut.Document.SubDbRecordAssociationCreated";
+/** Event: ContractBuyOut__Document link deleted */
+export declare const ROUTING_KEY_LINK_CONTRACT_BUY_OUT_DOCUMENT_DELETED = "OrderModule.ContractBuyOut.Document.SubDbRecordAssociationDeleted";

package/dist/entities-v2/ContractBuyOut.js

@@ -12,7 +12,7 @@
  * Generated from Odin schema definition
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_USER_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_USER_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_FILE_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_FILE_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_NOTE_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_NOTE_CREATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DEFAULT_DELETED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DEFAULT_UPDATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DEFAULT_CREATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_UPDATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_CREATED = exports.ContractBuyOut = exports.ContractBuyOutPropertyKeys = exports.ContractBuyOutUploadedFrom = exports.ContractBuyOutPreviousProvider = exports.DefaultContractBuyOutStageKeys = exports.DefaultContractBuyOutStageNames = exports.ContractBuyOutEntityTypes = void 0;
+exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_DOCUMENT_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_DOCUMENT_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_USER_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_USER_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_FILE_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_FILE_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_CREATED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_NOTE_DELETED = exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_NOTE_CREATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DEFAULT_DELETED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DEFAULT_UPDATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DEFAULT_CREATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_DELETED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_UPDATED = exports.ROUTING_KEY_CONTRACT_BUY_OUT_CREATED = exports.ContractBuyOut = exports.ContractBuyOutPropertyKeys = exports.ContractBuyOutUploadedFrom = exports.ContractBuyOutPreviousProvider = exports.DefaultContractBuyOutStageKeys = exports.DefaultContractBuyOutStageNames = exports.ContractBuyOutEntityTypes = void 0;
 const core_1 = require("@d19n/odin-types/dist/core");
 /**
  * Available types for ContractBuyOut records
@@ -223,3 +223,7 @@ exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_USER_DELETED = 'OrderModule.ContractBu
 exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_CREATED = 'OrderModule.ContractBuyOut.PaymentMethodRefund.SubDbRecordAssociationCreated';
 /** Event: ContractBuyOut__PaymentMethodRefund link deleted */
 exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_PAYMENT_METHOD_REFUND_DELETED = 'OrderModule.ContractBuyOut.PaymentMethodRefund.SubDbRecordAssociationDeleted';
+/** Event: ContractBuyOut__Document link created */
+exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_DOCUMENT_CREATED = 'OrderModule.ContractBuyOut.Document.SubDbRecordAssociationCreated';
+/** Event: ContractBuyOut__Document link deleted */
+exports.ROUTING_KEY_LINK_CONTRACT_BUY_OUT_DOCUMENT_DELETED = 'OrderModule.ContractBuyOut.Document.SubDbRecordAssociationDeleted';