@campfire-interactive/master-data-client 5.55.0 → 5.57.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/types.d.ts CHANGED
@@ -605,6 +605,52 @@ export interface Rfq {
605
605
  /** Which quote won. Present exactly when `status` is `won`. A recorded fact
606
606
  * — closing the siblings is a later phase. */
607
607
  wonByQuoteId: string | null;
608
+ /**
609
+ * The ONE quote of this RFQ whose figures REPRESENT it.
610
+ *
611
+ * **⚠ This is not {@link Rfq.wonByQuoteId}, and it is the field most likely
612
+ * to be mistaken for it.** The winner says *this quote was AWARDED* and
613
+ * exists only on a `won` RFQ. The carried quote says *this quote's numbers
614
+ * stand for the request* and exists at any status — **an open RFQ has a
615
+ * carried quote and no winner**, which is the normal case and the reason
616
+ * the field exists.
617
+ *
618
+ * Read it wherever you need ONE number for an RFQ. Its quotes are
619
+ * ALTERNATIVES — three of four lose on every multi-scenario RFQ by
620
+ * construction — so summing them multiply-counts the same business, and
621
+ * picking one yourself is a different wrong answer. This is the figure the
622
+ * tenant has nominated.
623
+ *
624
+ * **Defaulted, not required.** The first of the RFQ's quotes to reach
625
+ * `submitted` fills it, and a later submission does NOT re-seat it: a value
626
+ * already there may be one a person chose, and moving it would move the
627
+ * pipeline figure under them. An RFQ with nothing submitted carries
628
+ * nothing, and null means exactly that — do not substitute a draft.
629
+ *
630
+ * **A carried quote that DIES is released.** When it reaches `lost` or
631
+ * `not_taken` the RFQ takes the freshest surviving quote of its own that
632
+ * reached the customer, or null when none has. So this never points at a
633
+ * dead figure, and a null you read may be an RFQ whose quotes all died
634
+ * rather than one nobody has quoted yet — both mean the same thing to a
635
+ * consumer: no figure.
636
+ *
637
+ * **A carried quote that LEAVES is released the same way.** Moving a quote to
638
+ * another RFQ through `quotes.update`, or detaching it, hands the one it left
639
+ * to a survivor by the same rule. Without that the RFQ it left would be
640
+ * represented by a quote now competing somewhere else.
641
+ *
642
+ * **On an awarded RFQ it IS the winner.** The request is decided, so the
643
+ * figure representing it is the one that won; `rfqs.update` refuses a patch
644
+ * naming another quote there rather than silently overruling it. A winner
645
+ * archived afterwards keeps the pointer — that is a record, not a stale
646
+ * value, and `wonByQuoteId` behaves the same way. REOPENING is where that
647
+ * ends: an RFQ leaving `won` keeps its carried quote, but if that quote died
648
+ * while the RFQ was awarded it is released, because an open RFQ may not be
649
+ * represented by a lost one.
650
+ *
651
+ * Always one of this RFQ's own quotes — `rfqs.update` 422s otherwise.
652
+ */
653
+ carriedQuoteId: string | null;
608
654
  /** What absorbed this RFQ. Present exactly when `status` is `merged`. */
609
655
  mergedIntoRfqId: string | null;
610
656
  /** When the RFQ stopped being open. Set for every non-open status,
@@ -679,6 +725,19 @@ export interface UpdateRfqInput {
679
725
  status?: RfqStatus;
680
726
  /** Required when `status` is `won`; must be one of this RFQ's own quotes. */
681
727
  wonByQuoteId?: string | null;
728
+ /**
729
+ * Override which quote's figures represent this RFQ — see
730
+ * {@link Rfq.carriedQuoteId}. Not a second winner.
731
+ *
732
+ * Must be one of this RFQ's own quotes (422 otherwise). On an awarded RFQ
733
+ * it must be the quote that won, so sending a different one is a 422 rather
734
+ * than a silent overrule; sending the winner, or omitting the field, is
735
+ * always fine.
736
+ *
737
+ * Absent from {@link CreateRfqInput} deliberately: a new RFQ has no quotes,
738
+ * so nothing could satisfy the membership rule.
739
+ */
740
+ carriedQuoteId?: string | null;
682
741
  /** Required when `status` is `merged`. Prefer `rfqs.merge(id, target)`. */
683
742
  mergedIntoRfqId?: string | null;
684
743
  }
@@ -1474,6 +1533,19 @@ export interface RecordEngineeringChangeDecisionsInput {
1474
1533
  effectiveDate?: string;
1475
1534
  }>;
1476
1535
  }
1536
+ /**
1537
+ * The date an ACCEPTED line's new cost and price actually took effect — the
1538
+ * date the in-force lookup counts it from. `null` clears one entered by
1539
+ * mistake. Since 5.56.0.
1540
+ */
1541
+ export interface SetEngineeringChangeEffectiveDatesInput {
1542
+ callerRole: EcCallerRole;
1543
+ lines: Array<{
1544
+ lineId: string;
1545
+ /** YYYY-MM-DD, or null to clear. */
1546
+ effectiveDate: string | null;
1547
+ }>;
1548
+ }
1477
1549
  /** Where an in-force figure came from. */
1478
1550
  export type InForceSource = {
1479
1551
  kind: 'engineering_change';
@@ -5016,6 +5088,28 @@ export interface SetQuoteContractInput {
5016
5088
  /** The signed contract's DMS document id. */
5017
5089
  documentId?: string | null;
5018
5090
  }
5091
+ /** A cost bucket (since 5.57.0). See CostBucketResource. */
5092
+ export interface CostBucket {
5093
+ id: string;
5094
+ /** Slugged from the name at creation; never changes. */
5095
+ key: string;
5096
+ name: string;
5097
+ /** The kind of cost row that files here by default; null on a bucket the tenant added. */
5098
+ role: 'material' | 'labor' | 'overhead' | 'tooling' | null;
5099
+ displayOrder: number;
5100
+ archived: boolean;
5101
+ }
5102
+ /** One row of the list saved whole: an existing bucket by id, or a new one. */
5103
+ export interface CostBucketDraft {
5104
+ id?: string;
5105
+ name: string;
5106
+ }
5107
+ export interface ImportCostBucketInput {
5108
+ key: string;
5109
+ name: string;
5110
+ displayOrder?: number;
5111
+ archived?: boolean;
5112
+ }
5019
5113
  export interface Workstream {
5020
5114
  id: string;
5021
5115
  /** Slugged from the name at creation; never changes. */