@campfire-interactive/master-data-client 3.0.2 → 3.1.2

package/dist/types.d.ts

@@ -111,7 +111,7 @@ export type QuoteStatus = 'draft' | 'costing_requested' | 'costing_in_progress'
  */
 export type QuoteCallerRole = 'omsf' | 'cpq' | 'admin';
 /**
- * Quote type discriminator (added 3.1.0). `rfq` = new-business quote (the
+ * Quote type discriminator (added 3.0.2). `rfq` = new-business quote (the
  * default and the only kind before 2026-07). `eco` = Engineering Change
  * Order quote — a change against an already-awarded quote's assembly,
  * priced and approved as its own quote. Immutable post-create. When 'eco',
@@ -204,13 +204,13 @@ export interface Quote {
      */
     effectiveVolumesByYear: EffectiveVolumeByYear[] | null;
     status: QuoteStatus;
-    /** rfq | eco — see {@link QuoteType}. Immutable post-create. (3.1.0) */
+    /** rfq | eco — see {@link QuoteType}. Immutable post-create. (3.0.2) */
     quoteType: QuoteType;
     /**
      * ECO-only: the source quote's as-awarded unit price/cost, frozen at ECO
      * creation. The stored operands for delta reporting — readers compute
      * delta = effective − baseline; the delta itself is never stored. Always
-     * null on rfq-type quotes. Decimal-as-string like targetPrice. (3.1.0)
+     * null on rfq-type quotes. Decimal-as-string like targetPrice. (3.0.2)
      */
     baselineUnitPrice: string | null;
     baselineUnitCost: string | null;
@@ -288,13 +288,13 @@ export interface CreateQuoteInput {
     /**
      * Quote type — defaults to 'rfq'. Immutable post-create. When 'eco',
      * `referenceQuoteId` becomes REQUIRED and must point to an in-tenant,
-     * AWARDED, non-eco quote (server-validated). (3.1.0)
+     * AWARDED, non-eco quote (server-validated). (3.0.2)
      */
     quoteType?: QuoteType;
     /** ECO-only (422 otherwise): frozen as-awarded unit price of the source
-     *  quote. Decimal as number or string; string preferred. (3.1.0) */
+     *  quote. Decimal as number or string; string preferred. (3.0.2) */
     baselineUnitPrice?: number | string;
-    /** ECO-only (422 otherwise): frozen as-awarded unit cost. (3.1.0) */
+    /** ECO-only (422 otherwise): frozen as-awarded unit cost. (3.0.2) */
     baselineUnitCost?: number | string;
 }
 /**
@@ -356,7 +356,7 @@ export interface ListQuotesOptions {
     quality?: 'draft' | 'verified';
     customerCompanyId?: string;
     programId?: string;
-    /** Filter by quote type. Omitting returns both kinds. (3.1.0) */
+    /** Filter by quote type. Omitting returns both kinds. (3.0.2) */
     quoteType?: QuoteType;
     include?: ('customerCompany' | 'program')[];
 }
@@ -422,9 +422,14 @@ export interface Plant {
     region: string | null;
     headcount: number | null;
     annualCapacityHours: number | null;
+    /** Annual throughput capacity in units (distinct from annualCapacityHours). */
+    annualCapacityUnits: number | null;
     /** 0..1. */
     currentUtilization: number | null;
     riskLevel: string | null;
+    /** Plant operating currency (ISO 4217). Ergonomic default for rate entry;
+     *  rate values carry their own authoritative currency. Defaults to "USD". */
+    currency: string;
     numShifts: number;
     hoursPerShift: number;
     workingDaysPerYear: number;
@@ -449,8 +454,10 @@ export interface CreatePlantInput {
     region?: string;
     headcount?: number;
     annualCapacityHours?: number;
+    annualCapacityUnits?: number;
     currentUtilization?: number;
     riskLevel?: string;
+    currency?: string;
     numShifts?: number;
     hoursPerShift?: number;
     workingDaysPerYear?: number;
@@ -467,8 +474,10 @@ export interface UpdatePlantInput {
     region?: string | null;
     headcount?: number | null;
     annualCapacityHours?: number | null;
+    annualCapacityUnits?: number | null;
     currentUtilization?: number | null;
     riskLevel?: string | null;
+    currency?: string;
     numShifts?: number;
     hoursPerShift?: number;
     workingDaysPerYear?: number;
@@ -536,6 +545,8 @@ export interface MergePlantsRequest {
 export type RateLibraryStatus = 'draft' | 'active' | 'archived';
 export type RateEntryKind = 'labor' | 'machine' | 'overhead' | 'material' | 'freight';
 export type RateSourcingMode = 'fixed' | 'indexed';
+export type RateRollForwardMode = 'carry_forward_flagged' | 'blank_force_entry';
+export type RateValueOrigin = 'entered' | 'escalated' | 'overridden' | 'carried_forward';
 export interface RateLibrary {
     id: string;
     tenantId: string;
@@ -545,6 +556,13 @@ export interface RateLibrary {
     currency: string;
     effectiveDate: string;
     effectiveTo: string | null;
+    /** Multi-year projection horizon (calendar years) + book-level escalation
+     *  and roll-forward policy. Carried over from CPQ's RateBook. Null horizon
+     *  = single-window library. Added in the 2026-07-02 rate superset. */
+    horizonStart: number | null;
+    horizonEnd: number | null;
+    escalationPct: number;
+    rollForwardMode: RateRollForwardMode;
     status: RateLibraryStatus;
     quality: 'draft' | 'verified';
     version: number;
@@ -568,17 +586,35 @@ export interface RateEntry {
     rateLibraryId: string;
     kind: RateEntryKind;
     plantId: string | null;
+    /** Equipment scope for machine-burden rates (superset). */
+    equipmentId: string | null;
+    equipmentCode: string | null;
     skillTier: string | null;
     materialId: string | null;
+    /** Material grade code — resolves to a RateGrade for density. */
+    gradeCode: string | null;
     regionId: string | null;
     lane: string | null;
+    /** Freight mode + packaging container qualifiers. */
+    mode: string | null;
+    container: string | null;
     /** Decimal serialized as string to preserve precision across the wire. */
     rate: string;
+    /** Canonical mass-basis cost (Decimal string), derived for material rates. */
+    ratePerKg: string | null;
     unit: string;
     currency: string;
+    /** Per-year projection window (null = inherits the library window). */
+    effectiveFrom: string | null;
+    effectiveTo: string | null;
+    /** Per-row escalation override (null = inherit the library default). */
+    escalationPct: number | null;
+    origin: RateValueOrigin;
     sourcingMode: RateSourcingMode;
     indexRef: string | null;
     lastSyncedAt: string | null;
+    sourceSystem: string | null;
+    externalRef: string | null;
     notes: string | null;
     createdBy: string;
     updatedBy: string;
@@ -592,6 +628,10 @@ export interface CreateRateLibraryInput {
     currency?: string;
     effectiveDate: string;
     effectiveTo?: string | null;
+    horizonStart?: number | null;
+    horizonEnd?: number | null;
+    escalationPct?: number;
+    rollForwardMode?: RateRollForwardMode;
 }
 export interface UpdateRateLibraryInput {
     name?: string;
@@ -600,6 +640,19 @@ export interface UpdateRateLibraryInput {
     effectiveDate?: string;
     effectiveTo?: string | null;
     quality?: 'draft' | 'verified';
+    horizonStart?: number | null;
+    horizonEnd?: number | null;
+    escalationPct?: number;
+    rollForwardMode?: RateRollForwardMode;
+}
+export interface RollForwardResult {
+    libraryId: string;
+    horizonStart: number;
+    horizonEnd: number;
+    mode: RateRollForwardMode;
+    seedsProjected: number;
+    rowsCreated: number;
+    rowsReplaced: number;
 }
 export interface ListRateLibrariesOptions {
     limit?: number;
@@ -618,29 +671,53 @@ export interface GetRateLibraryOptions {
 export interface CreateRateEntryInput {
     kind: RateEntryKind;
     plantId?: string | null;
+    equipmentId?: string | null;
+    equipmentCode?: string | null;
     skillTier?: string | null;
     materialId?: string | null;
+    gradeCode?: string | null;
     regionId?: string | null;
     lane?: string | null;
+    mode?: string | null;
+    container?: string | null;
     /** Number accepted; string preferred for precision. */
     rate: number | string;
+    ratePerKg?: number | string | null;
     unit: string;
     currency?: string;
+    effectiveFrom?: string | null;
+    effectiveTo?: string | null;
+    escalationPct?: number | null;
+    origin?: RateValueOrigin;
     sourcingMode?: RateSourcingMode;
     indexRef?: string | null;
+    sourceSystem?: string | null;
+    externalRef?: string | null;
     notes?: string | null;
 }
 export interface UpdateRateEntryInput {
     plantId?: string | null;
+    equipmentId?: string | null;
+    equipmentCode?: string | null;
     skillTier?: string | null;
     materialId?: string | null;
+    gradeCode?: string | null;
     regionId?: string | null;
     lane?: string | null;
+    mode?: string | null;
+    container?: string | null;
     rate?: number | string;
+    ratePerKg?: number | string | null;
     unit?: string;
     currency?: string;
+    effectiveFrom?: string | null;
+    effectiveTo?: string | null;
+    escalationPct?: number | null;
+    origin?: RateValueOrigin;
     sourcingMode?: RateSourcingMode;
     indexRef?: string | null;
+    sourceSystem?: string | null;
+    externalRef?: string | null;
     notes?: string | null;
 }
 export interface ListRateEntriesOptions {
@@ -649,10 +726,15 @@ export interface ListRateEntriesOptions {
 export interface RateLookupInput {
     kind: RateEntryKind;
     plantId?: string | null;
+    equipmentId?: string | null;
+    equipmentCode?: string | null;
     skillTier?: string | null;
     materialId?: string | null;
+    gradeCode?: string | null;
     regionId?: string | null;
     lane?: string | null;
+    mode?: string | null;
+    container?: string | null;
     /** ISO date (YYYY-MM-DD). Defaults to today. */
     asOf?: string;
 }
@@ -664,6 +746,8 @@ export interface RateLookupResult {
     kind: RateEntryKind;
     /** Decimal serialized as string. */
     rate: string;
+    /** Decimal serialized as string; null when not a mass-basis material rate. */
+    ratePerKg: string | null;
     unit: string;
     currency: string;
     sourcingMode: RateSourcingMode;
@@ -673,12 +757,187 @@ export interface RateLookupResult {
     /** Echoes the dimensions on the matched entry — handy for consumer audit logging. */
     resolvedFrom: {
         plantId: string | null;
+        equipmentId: string | null;
+        equipmentCode: string | null;
         skillTier: string | null;
         materialId: string | null;
+        gradeCode: string | null;
         regionId: string | null;
         lane: string | null;
+        mode: string | null;
+        container: string | null;
     };
 }
+export interface PlantEquipment {
+    id: string;
+    tenantId: string;
+    plantId: string;
+    code: string;
+    name: string;
+    processFamily: string;
+    capacityHoursPerYear: number;
+    cavities: number;
+    /** OEE availability factor (0..1). */
+    availabilityPct: number;
+    /** OEE performance factor (0..1). */
+    performancePct: number;
+    /** CPQ-authored operational defaults — advisory metadata for non-CPQ apps. */
+    defaultHeadcount: number;
+    defaultAutomationPct: number;
+    defaultMachinesPerOperator: number;
+    defaultSetupCrew: number;
+    status: PlantStatus;
+    quality: 'draft' | 'verified';
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+    plant?: Plant;
+}
+export interface CreateEquipmentInput {
+    plantId: string;
+    code: string;
+    name: string;
+    processFamily: string;
+    capacityHoursPerYear?: number;
+    cavities?: number;
+    availabilityPct?: number;
+    performancePct?: number;
+    defaultHeadcount?: number;
+    defaultAutomationPct?: number;
+    defaultMachinesPerOperator?: number;
+    defaultSetupCrew?: number;
+    quality?: 'draft' | 'verified';
+}
+export interface UpdateEquipmentInput {
+    code?: string;
+    name?: string;
+    processFamily?: string;
+    capacityHoursPerYear?: number;
+    cavities?: number;
+    availabilityPct?: number;
+    performancePct?: number;
+    defaultHeadcount?: number;
+    defaultAutomationPct?: number;
+    defaultMachinesPerOperator?: number;
+    defaultSetupCrew?: number;
+    quality?: 'draft' | 'verified';
+}
+export interface ListEquipmentOptions {
+    limit?: number;
+    cursor?: string;
+    sort?: string;
+    q?: string;
+    status?: PlantStatus | 'all';
+    quality?: 'draft' | 'verified';
+    plantId?: string;
+    processFamily?: string;
+    include?: 'plant'[];
+}
+export interface GetEquipmentOptions {
+    include?: 'plant'[];
+}
+export interface ProcessFamily {
+    id: string;
+    tenantId: string;
+    code: string;
+    name: string;
+    description: string | null;
+    sortOrder: number;
+    status: PlantStatus;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateProcessFamilyInput {
+    code: string;
+    name: string;
+    description?: string;
+    sortOrder?: number;
+}
+export interface UpdateProcessFamilyInput {
+    name?: string;
+    description?: string | null;
+    sortOrder?: number;
+    status?: 'active' | 'archived';
+}
+export interface Uom {
+    id: string;
+    tenantId: string;
+    code: string;
+    name: string;
+    dimension: string | null;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateUomInput {
+    code: string;
+    name: string;
+    dimension?: string;
+}
+export interface UpdateUomInput {
+    name?: string;
+    dimension?: string | null;
+}
+export interface RateLine {
+    id: string;
+    tenantId: string;
+    code: string;
+    name: string;
+    kind: RateEntryKind;
+    allowedUoms: string[];
+    description: string | null;
+    sortOrder: number;
+    status: PlantStatus;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateRateLineInput {
+    code: string;
+    name: string;
+    kind: RateEntryKind;
+    allowedUoms?: string[];
+    description?: string;
+    sortOrder?: number;
+}
+export interface UpdateRateLineInput {
+    name?: string;
+    kind?: RateEntryKind;
+    allowedUoms?: string[];
+    description?: string | null;
+    sortOrder?: number;
+    status?: 'active' | 'archived';
+}
+export interface RateGrade {
+    id: string;
+    tenantId: string;
+    code: string;
+    name: string;
+    materialId: string | null;
+    density: number | null;
+    status: PlantStatus;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateRateGradeInput {
+    code: string;
+    name: string;
+    materialId?: string | null;
+    density?: number | null;
+}
+export interface UpdateRateGradeInput {
+    name?: string;
+    materialId?: string | null;
+    density?: number | null;
+    status?: 'active' | 'archived';
+}
 export type ExchangeRateStatus = 'draft' | 'active' | 'archived';
 export type ExchangeRateScope = 'tenant' | 'global';
 export interface ExchangeRate {
@@ -782,7 +1041,10 @@ export interface Part {
     manufacturingPartNumber: string | null;
     name: string;
     description: string | null;
+    /** @deprecated free-text; use partTypeId (governed PartType catalog). */
     partType: string | null;
+    /** The per-tenant PartType this part is classified as. */
+    partTypeId: string | null;
     /** The per-tenant PartCategory this part belongs to. */
     partCategoryId: string | null;
     manufacturer: string | null;
@@ -795,6 +1057,9 @@ export interface Part {
     createdAt: string;
     updatedAt: string;
     partCategory?: PartCategory;
+    /** Resolved PartType (?include=partType). Named partTypeRef server-side during
+     *  the additive window; exposed here as the resolved catalog row. */
+    partTypeRef?: PartType;
     currentRevision?: PartRevision;
     revisions?: PartRevision[];
     /** Which app most-recently wrote any field on this row (provenance). */
@@ -826,7 +1091,9 @@ export interface CreatePartInput {
     manufacturingPartNumber?: string | null;
     name: string;
     description?: string | null;
+    /** @deprecated free-text; use partTypeId. */
     partType?: string | null;
+    partTypeId?: string | null;
     partCategoryId?: string | null;
     manufacturer?: string | null;
     quality?: 'draft' | 'verified';
@@ -836,7 +1103,9 @@ export interface UpdatePartInput {
     manufacturingPartNumber?: string | null;
     name?: string;
     description?: string | null;
+    /** @deprecated free-text; use partTypeId. */
     partType?: string | null;
+    partTypeId?: string | null;
     partCategoryId?: string | null;
     manufacturer?: string | null;
     quality?: 'draft' | 'verified';
@@ -862,6 +1131,7 @@ export interface ListPartsOptions {
     status?: PartStatus | 'all';
     quality?: 'draft' | 'verified';
     partCategoryId?: string;
+    partTypeId?: string;
     partType?: string;
     manufacturer?: string;
     include?: string[];
@@ -974,6 +1244,56 @@ export interface ListPartCategoriesOptions {
     /** When true, request only active categories (drops archived). */
     activeOnly?: boolean;
 }
+export interface PartTypeDefault {
+    id: string;
+    code: string;
+    name: string;
+    displayOrder: number;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreatePartTypeDefaultInput {
+    code: string;
+    name: string;
+    displayOrder?: number;
+}
+export interface UpdatePartTypeDefaultInput {
+    code?: string;
+    name?: string;
+    displayOrder?: number;
+}
+export type PartTypeStatus = 'active' | 'archived';
+export interface PartType {
+    id: string;
+    tenantId: string;
+    code: string;
+    name: string;
+    displayOrder: number;
+    status: PartTypeStatus;
+    /** True for tool-seeded defaults: protected (no delete/archive/code-change). */
+    isDefault: boolean;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreatePartTypeInput {
+    code: string;
+    name: string;
+    displayOrder?: number;
+}
+export interface UpdatePartTypeInput {
+    code?: string;
+    name?: string;
+    displayOrder?: number;
+    status?: PartTypeStatus;
+}
+export interface ListPartTypesOptions {
+    /** When true, request only active types (drops archived). */
+    activeOnly?: boolean;
+}
 export interface AuditLogEntry {
     id: string;
     tenantId: string | null;