@campfire-interactive/master-data-client 5.10.1 → 5.11.0

package/dist/quoteStatus.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLOSED_QUOTE_STATUSES = exports.OPEN_QUOTE_STATUSES = void 0;
+exports.quoteStatusBucket = quoteStatusBucket;
+exports.isOpenQuoteStatus = isOpenQuoteStatus;
+/**
+ * The one table. `Record<QuoteStatus, …>` is what makes it exhaustive: adding
+ * a status to {@link QuoteStatus} without bucketing it here fails to compile,
+ * which is the only way to keep this from drifting behind the state machine.
+ *
+ * `lost` and `not_taken` share a bucket here and stay distinct everywhere else
+ * — see {@link QuoteStatus} on why collapsing them miscounts a won deal as a
+ * defeat. This bucket answers only "should the row be in the working list?",
+ * and that answer is the same for both.
+ */
+const BUCKET_BY_STATUS = {
+    draft: 'open',
+    costing_requested: 'open',
+    costing_in_progress: 'open',
+    costing_complete: 'open',
+    pricing: 'open',
+    routed_for_approval: 'open',
+    in_review: 'open',
+    approved: 'open',
+    submitted: 'open',
+    negotiating: 'open',
+    awarded: 'awarded',
+    lost: 'closed',
+    not_taken: 'closed',
+};
+const statusesIn = (bucket) => Object.keys(BUCKET_BY_STATUS).filter((s) => BUCKET_BY_STATUS[s] === bucket);
+/**
+ * Still work: draft through negotiating. Mirrors the server's `OPEN_STATUSES`
+ * and is the set behind `GET /v1/quotes?status=open`.
+ */
+exports.OPEN_QUOTE_STATUSES = statusesIn('open');
+/** Closed and not won: `lost`, `not_taken`. */
+exports.CLOSED_QUOTE_STATUSES = statusesIn('closed');
+/**
+ * Which bucket a status falls in. An unrecognized value is reported as `open`:
+ * a status this build hasn't heard of is far likelier to be a newly added
+ * working state than a new terminal one, and the failure that matters is
+ * hiding live work, not listing one row too many.
+ */
+function quoteStatusBucket(status) {
+    if (status == null)
+        return 'open';
+    return BUCKET_BY_STATUS[status] ?? 'open';
+}
+/** True for every status in {@link OPEN_QUOTE_STATUSES}. */
+function isOpenQuoteStatus(status) {
+    return quoteStatusBucket(status) === 'open';
+}
+//# sourceMappingURL=quoteStatus.js.map

package/dist/quoteStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quoteStatus.js","sourceRoot":"","sources":["../src/quoteStatus.ts"],"names":[],"mappings":";;;AAoEA,8CAKC;AAGD,8CAEC;AAxDD;;;;;;;;;GASG;AACH,MAAM,gBAAgB,GAAG;IACvB,KAAK,EAAE,MAAM;IACb,iBAAiB,EAAE,MAAM;IACzB,mBAAmB,EAAE,MAAM;IAC3B,gBAAgB,EAAE,MAAM;IACxB,OAAO,EAAE,MAAM;IACf,mBAAmB,EAAE,MAAM;IAC3B,SAAS,EAAE,MAAM;IACjB,QAAQ,EAAE,MAAM;IAChB,SAAS,EAAE,MAAM;IACjB,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,QAAQ;CACsC,CAAC;AAE5D,MAAM,UAAU,GAAG,CAAC,MAAyB,EAA0B,EAAE,CACtE,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAmB,CAAC,MAAM,CACrD,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,KAAK,MAAM,CACtC,CAAC;AAEJ;;;GAGG;AACU,QAAA,mBAAmB,GAA2B,UAAU,CAAC,MAAM,CAAC,CAAC;AAE9E,+CAA+C;AAClC,QAAA,qBAAqB,GAA2B,UAAU,CAAC,QAAQ,CAAC,CAAC;AAElF;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,MAA+C;IAE/C,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,OAAO,gBAAgB,CAAC,MAAqB,CAAC,IAAI,MAAM,CAAC;AAC3D,CAAC;AAED,4DAA4D;AAC5D,SAAgB,iBAAiB,CAAC,MAA+C;IAC/E,OAAO,iBAAiB,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC;AAC9C,CAAC"}

package/dist/types.d.ts

@@ -875,10 +875,16 @@ export interface ListQuotesOptions {
     sort?: string;
     q?: string;
     /**
-     * `all` returns every status. Omitting defaults to "not lost" — the
-     * common active-deals feed. Pass `lost` (or `all`) to include them.
+     * `all` returns every status. `open` returns only the statuses still in
+     * play — `OPEN_QUOTE_STATUSES`, i.e. everything but `awarded`, `lost` and
+     * `not_taken`. (5.10.2)
+     *
+     * Omitting defaults to "not closed": `lost` and `not_taken` are excluded,
+     * `awarded` is not. That default is deliberately unchanged — it is what
+     * every existing consumer is built on — so a caller that wants awarded
+     * quotes out of its list asks for `open` explicitly.
      */
-    status?: QuoteStatus | 'all';
+    status?: QuoteStatus | 'all' | 'open';
     quality?: 'draft' | 'verified';
     customerCompanyId?: string;
     programId?: string;
@@ -2212,20 +2218,116 @@ export interface ExchangeRate {
     createdAt: string;
     updatedAt: string;
 }
-export interface CreateExchangeRateInput {
+/**
+ * The rate half of a create/update. Supply EXACTLY ONE of `perUsd` (the stored
+ * unit) or `perBase` (units per 1 `base`, converted to per-USD on write).
+ * Supplying both is a 422 rather than a silent preference.
+ *
+ * Base-relative entry exists because a tenant whose base is EUR holds a
+ * EUR-relative feed. The conversion is server-side, `perBase × perUsd(base)`
+ * resolved as of the row's own `effectiveFrom`, so the figure that lands is the
+ * one costing would have derived for that date. **Storage is unchanged** —
+ * `ExchangeRate.perUsd` and `FxTable.base: 'USD'` are exactly as before.
+ */
+export interface ExchangeRateEntryInput {
+    /** Units of `currency` per 1 USD — the stored unit. */
+    perUsd?: number | string;
+    /** Units of `currency` per 1 `base`. */
+    perBase?: number | string;
+    /**
+     * The unit `perBase` is expressed in. Defaults to the tenant's configured
+     * base currency (see `exchangeRates.settings()`).
+     *
+     * Two rules to know when this is not USD:
+     * - `currency === base` is rejected; a currency is 1 per 1 of itself.
+     * - `currency === 'USD'` is **the anchor**: `perBase(USD)` is `1/perUsd(base)`,
+     *   so it restates the base↔USD rate and writes a row for **`base`**, not for
+     *   USD. The returned `ExchangeRate` reports the row actually written, so read
+     *   `.currency` off the response rather than assuming what you sent.
+     */
+    base?: string;
+}
+export interface CreateExchangeRateInput extends ExchangeRateEntryInput {
     currency: string;
-    perUsd: number | string;
     /** YYYY-MM-DD. */
     effectiveFrom: string;
     effectiveTo?: string | null;
     notes?: string | null;
 }
-export interface UpdateExchangeRateInput {
-    perUsd?: number | string;
+export interface UpdateExchangeRateInput extends ExchangeRateEntryInput {
     effectiveFrom?: string;
     effectiveTo?: string | null;
     notes?: string | null;
 }
+/**
+ * A tenant's FX settings. `baseCurrency` is the unit this tenant's people READ
+ * and TYPE rates in — NOT a storage pivot. `/v1/fx/table` still reports
+ * `base: 'USD'` to every consumer regardless of what this says, and no stored
+ * rate changes when it is flipped.
+ */
+export interface TenantFxSettings {
+    /** ISO-4217 code. `'USD'` when the tenant has never set one. */
+    baseCurrency: string;
+    /** False when no row exists yet and this is the platform default. */
+    customized: boolean;
+}
+export interface UpdateTenantFxSettingsInput {
+    /** Must be a currency that is enabled in the tenant's catalog. */
+    baseCurrency?: string;
+}
+export type CurrencyScope = 'global' | 'tenant';
+/**
+ * One entry in a tenant's effective currency catalog.
+ *
+ * Mixed tenancy, the same shape as ExchangeRate: the platform seeds the active
+ * ISO-4217 set as shared rows, and a tenant row for the same code shadows one
+ * to rename or hide it for that tenant alone. A tenant row for a code the seed
+ * does not carry is a custom currency.
+ *
+ * `active` is CURATION, not deletion. 155 codes is a useless picker, so a
+ * tenant turns off what it does not trade in. It never invalidates history:
+ * membership is enforced only on NEW writes, so rates already written against
+ * a code keep resolving.
+ */
+export interface Currency {
+    /** ISO-4217 code, uppercase. */
+    code: string;
+    name: string;
+    symbol: string | null;
+    /** ISO-4217 exponent. Drives money FORMATTING only — rates are 6-dp decimals. */
+    minorUnits: number;
+    active: boolean;
+    /** Which row won: `tenant` when this tenant authored or overrode it. */
+    scope: CurrencyScope;
+    /** True when a tenant row shadows a seeded global of the same code. */
+    overridesGlobal: boolean;
+    /** True when only this tenant has it — not part of the seeded ISO set. */
+    custom: boolean;
+}
+export interface ListCurrenciesOptions {
+    /** Default true. Pass false for just the enabled ones — what a picker wants. */
+    includeInactive?: boolean;
+    /** Case-insensitive substring match on code or name. */
+    q?: string;
+}
+export interface CreateCurrencyInput {
+    code: string;
+    name: string;
+    symbol?: string | null;
+    /** 0-4. Defaults to 2. */
+    minorUnits?: number;
+    active?: boolean;
+}
+export interface UpdateCurrencyInput {
+    name?: string;
+    symbol?: string | null;
+    minorUnits?: number;
+    /**
+     * Enable or hide for this tenant. USD can never be turned off (every rate is
+     * stored against it), and neither can the tenant's own base currency.
+     */
+    active?: boolean;
+}
 export interface ListExchangeRatesOptions {
     limit?: number;
     cursor?: string;
@@ -2815,7 +2917,7 @@ export interface CreateAttributeDefinitionInput {
      *  for `hierarchy`, a `Parent > Child > Grandchild` path per entry, which the
      *  server turns into an option tree (shared prefixes dedupe).
      *
-     *  **Required for `enum`, `multi_select` and `hierarchy`** (since 5.10.0) — a
+     *  **Required for `enum`, `multi_select` and `hierarchy`** (since 5.10.1) — a
      *  select with no values renders as an empty picker, and marked required it
      *  is a dead end. Legacy inline `options` satisfies the same rule. */
     optionValues?: string[] | null;
@@ -3080,7 +3182,7 @@ export type SourceApp = 'master-data' | 'erfq' | 'cpq' | 'bom' | 'forecast' | 'o
  *  "Empty" means SQL NULL only — a stored '', 0, false, or 0.0 counts as
  *  populated and will not be overwritten by fill_empty. */
 export type MergePolicy = 'overwrite' | 'fill_empty';
-export type ImportTargetField = 'name' | 'legalName' | 'code' | 'taxId' | 'dunsNumber' | 'website' | 'logoUrl' | 'roles' | 'email' | 'phone' | 'role' | 'type' | 'description' | 'street' | 'city' | 'stateProvince' | 'postalCode' | 'country' | 'category' | 'parent_company_ref' | 'companyCode' | 'companyName' | 'locationCode' | 'region' | 'headcount' | 'annualCapacityHours' | 'currentUtilization' | 'riskLevel' | 'numShifts' | 'hoursPerShift' | 'workingDaysPerYear' | 'indirectHeadcountPct' | 'currency' | 'effectiveDate' | 'effectiveTo' | 'libraryCode' | 'kind' | 'plantCode' | 'skillTier' | 'materialCode' | 'regionCode' | 'lane' | 'rate' | 'unit' | 'sourcingMode' | 'indexRef' | 'notes' | 'partNumber' | 'manufacturingPartNumber' | 'customerPartNumber' | 'partType' | 'manufacturer' | 'partCategoryCode' | 'quality' | 'revision' | 'uom' | 'weightPerUnit' | 'recycledPct' | 'pcfPerUnit' | 'releaseStatus' | 'leadTime' | 'customerCompanyCode' | 'customerCompanyName' | 'sopDate' | 'eopDate' | 'displayOrder' | 'label' | 'sortOrder' | 'processFamily' | 'capacityHoursPerYear' | 'cavities' | 'availabilityPct' | 'performancePct' | 'defaultHeadcount' | 'defaultAutomationPct' | 'defaultMachinesPerOperator' | 'defaultSetupCrew' | 'perUsd' | 'effectiveFrom' | 'quoteNumber' | 'programCode' | 'partId' | 'regionName' | 'annualVolume' | 'apw' | 'mpw' | 'targetPrice' | 'dueDate' | 'status' | 'key' | 'dataType' | 'options' | 'group' | 'required' | 'min' | 'max' | 'regex' | 'precision' | 'basis' | 'bindings' | 'perBaseFactor' | 'needsDensity' | 'binding' | 'allowedUoms' | 'defaultUom' | 'escalationDefault' | 'density' | 'densityUnit' | `attr:${string}`;
+export type ImportTargetField = 'name' | 'legalName' | 'code' | 'taxId' | 'dunsNumber' | 'website' | 'logoUrl' | 'roles' | 'email' | 'phone' | 'role' | 'type' | 'description' | 'street' | 'city' | 'stateProvince' | 'postalCode' | 'country' | 'category' | 'parent_company_ref' | 'companyCode' | 'companyName' | 'locationCode' | 'region' | 'headcount' | 'annualCapacityHours' | 'currentUtilization' | 'riskLevel' | 'numShifts' | 'hoursPerShift' | 'workingDaysPerYear' | 'indirectHeadcountPct' | 'currency' | 'effectiveDate' | 'effectiveTo' | 'libraryCode' | 'kind' | 'plantCode' | 'skillTier' | 'materialCode' | 'regionCode' | 'lane' | 'rate' | 'unit' | 'sourcingMode' | 'indexRef' | 'notes' | 'partNumber' | 'manufacturingPartNumber' | 'customerPartNumber' | 'partType' | 'manufacturer' | 'partCategoryCode' | 'quality' | 'revision' | 'uom' | 'weightPerUnit' | 'recycledPct' | 'pcfPerUnit' | 'releaseStatus' | 'leadTime' | 'customerCompanyCode' | 'customerCompanyName' | 'sopDate' | 'eopDate' | 'displayOrder' | 'label' | 'sortOrder' | 'processFamily' | 'capacityHoursPerYear' | 'cavities' | 'availabilityPct' | 'performancePct' | 'defaultHeadcount' | 'defaultAutomationPct' | 'defaultMachinesPerOperator' | 'defaultSetupCrew' | 'perUsd' | 'base' | 'effectiveFrom' | 'quoteNumber' | 'programCode' | 'partId' | 'regionName' | 'annualVolume' | 'apw' | 'mpw' | 'targetPrice' | 'dueDate' | 'status' | 'key' | 'dataType' | 'options' | 'group' | 'required' | 'min' | 'max' | 'regex' | 'precision' | 'basis' | 'bindings' | 'perBaseFactor' | 'needsDensity' | 'binding' | 'allowedUoms' | 'defaultUom' | 'escalationDefault' | 'density' | 'densityUnit' | `attr:${string}`;
 export interface ImportSession {
     id: string;
     tenantId: string;
@@ -3848,4 +3950,211 @@ export interface AiLlmConfigRows {
     valid_providers: string[];
     suggested_models: Record<string, string[]>;
 }
+export type KnownWorkStepSubjectKind = 'quote' | 'vehicle_program' | 'launch_program';
+/** OPEN union: a new kind is an additive change, so do not switch exhaustively. */
+export type WorkStepSubjectKind = KnownWorkStepSubjectKind | (string & {});
+/** Stored state. `at_risk` and `past_due` are derived at read time (see WorkStepDisplayState). */
+export type WorkStepState = 'not_started' | 'open' | 'done';
+export type KnownWorkStepDisplayState = WorkStepState | 'at_risk' | 'past_due';
+export type WorkStepDisplayState = KnownWorkStepDisplayState | (string & {});
+/**
+ * How the timing was obtained. `late` is only claimable for `measured` and
+ * `signed_off`; everything else is a record, not a measurement.
+ */
+export type KnownWorkStepCertainty = 'measured' | 'signed_off' | 'observed' | 'recorded' | 'untracked';
+export type WorkStepCertainty = KnownWorkStepCertainty | (string & {});
+/** The role a write is made on behalf of. The server checks it against the subject kind. */
+export type WorkStepCallerRole = 'omsf' | 'cpq' | 'pm' | 'admin';
+export type WorkStepStandardUnit = 'hours' | 'days';
+export type WorkStepSlaBasis = 'internal' | 'elapsed';
+export type WorkStepAnchor = 'award' | 'sop' | 'eop' | 'gap_fraction' | 'custom';
+export interface WorkStepDefinition {
+    /** null when this is the platform default and the tenant has no row. */
+    id: string | null;
+    stepCode: string;
+    subjectKind: WorkStepSubjectKind;
+    variant: string;
+    grain: 'subject' | 'child';
+    plannedBasis: 'duration' | 'anchored_date' | 'fixed_date';
+    label: string;
+    milestone: string | null;
+    sortOrder: number;
+    parentCode: string | null;
+    standardQty: number | null;
+    standardUnit: WorkStepStandardUnit;
+    slaBasis: WorkStepSlaBasis;
+    anchor: WorkStepAnchor | null;
+    anchorFraction: number | null;
+    ownerRole: string | null;
+    ownerScope: 'tenant' | 'child_team';
+    measurementSource: string;
+    active: boolean;
+    /** true when a tenant row exists; false when this is the platform default. */
+    customized: boolean;
+}
+export interface ListWorkStepDefinitionsOptions {
+    /** Omit for every kind. */
+    subjectKind?: WorkStepSubjectKind;
+    /** 'default' or 'eco' (quote steps only). */
+    variant?: string;
+    includeInactive?: boolean;
+}
+export interface WorkStepDefinitionRowInput {
+    stepCode: string;
+    /** Program kinds only; the quote graph is fixed. */
+    label?: string;
+    milestone?: string | null;
+    sortOrder?: number;
+    standardQty?: number | null;
+    standardUnit?: WorkStepStandardUnit;
+    slaBasis?: WorkStepSlaBasis;
+    anchor?: WorkStepAnchor | null;
+    anchorFraction?: number | null;
+    ownerRole?: string | null;
+    active?: boolean;
+    /** Custom (non-catalog) program steps only. */
+    plannedBasis?: 'anchored_date' | 'fixed_date';
+}
+export interface SaveWorkStepDefinitionsInput {
+    subjectKind: WorkStepSubjectKind;
+    variant?: string;
+    rows: WorkStepDefinitionRowInput[];
+    /** Deactivate this kind's custom steps absent from `rows`. */
+    archiveMissing?: boolean;
+}
+/** One execution of a step. Dates are ISO-8601 strings on the wire. */
+export interface WorkStepEpisode {
+    id: string;
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    /** '' for a subject-grain step. */
+    childId: string;
+    childLabel: string | null;
+    stepCode: string;
+    iteration: number;
+    plannedStart: string | null;
+    plannedEnd: string | null;
+    actualStart: string | null;
+    actualEnd: string | null;
+    state: WorkStepState;
+    certainty: WorkStepCertainty;
+    openedBy: string | null;
+    closedBy: string | null;
+    reopenReason: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface WorkStepSeriesEntry {
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    childId: string;
+    childLabel: string | null;
+    stepCode: string;
+    /** The latest iteration wins. */
+    latest: WorkStepEpisode;
+    iterations: number;
+    reopenCount: number;
+    derived: {
+        displayState: WorkStepDisplayState;
+        /** null when it cannot be claimed. */
+        late: boolean | null;
+    };
+}
+export interface WorkStepKeyInput {
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    /** Required for per-child steps. */
+    childId?: string;
+    stepCode: string;
+    callerRole: WorkStepCallerRole;
+}
+export interface OpenWorkStepInput extends WorkStepKeyInput {
+    childLabel?: string | null;
+    variant?: string;
+    /** Plant whose calendar governs an internal-days standard. */
+    calendarSourceId?: string | null;
+    actualStart?: string | null;
+    plannedStart?: string | null;
+    plannedEnd?: string | null;
+    openedBy?: string | null;
+}
+export interface CloseWorkStepInput extends WorkStepKeyInput {
+    variant?: string;
+    actualEnd?: string | null;
+    closedBy?: string | null;
+    childLabel?: string | null;
+}
+export interface ReopenWorkStepInput extends WorkStepKeyInput {
+    variant?: string;
+    calendarSourceId?: string | null;
+    reopenReason: string;
+    openedBy?: string | null;
+}
+export interface BatchWorkStepEpisodeRow {
+    subjectType: WorkStepSubjectKind;
+    subjectId: string;
+    childId?: string;
+    stepCode: string;
+    /** The caller supplies the iteration here (default 1); open/reopen assign it server-side. */
+    iteration?: number;
+    childLabel?: string | null;
+    plannedStart?: string | null;
+    plannedEnd?: string | null;
+    actualStart?: string | null;
+    actualEnd?: string | null;
+    state?: WorkStepState;
+    certainty?: WorkStepCertainty;
+    openedBy?: string | null;
+    closedBy?: string | null;
+    reopenReason?: string | null;
+}
+export interface BatchWorkStepEpisodesInput {
+    callerRole: WorkStepCallerRole;
+    /** 1 to 500. Duplicate keys within one batch are a 422. */
+    episodes: BatchWorkStepEpisodeRow[];
+}
+export interface BatchWorkStepEpisodesResult {
+    created: number;
+    updated: number;
+    unchanged: number;
+    /** A done row is never regressed by a stale replay. */
+    skipped: number;
+}
+export interface ListWorkStepEpisodesOptions {
+    /** ISO-8601; the analytics feed's watermark. */
+    updatedSince?: string;
+    subjectType?: WorkStepSubjectKind;
+    stepCode?: string;
+    /** 1 to 1000. */
+    limit?: number;
+    cursor?: string;
+}
+export interface WorkingCalendarException {
+    id: string;
+    date: string;
+    working: boolean;
+    reason: string;
+}
+export interface WorkingCalendar {
+    id: string;
+    /** master-data Plant id. */
+    productionSourceId: string;
+    sourceLabel: string | null;
+    /** UTC weekday numbers that are working days, 0 = Sunday. Never empty. */
+    workingDays: number[];
+    timeZone: string | null;
+    exceptions?: WorkingCalendarException[];
+}
+export interface UpsertWorkingCalendarInput {
+    sourceLabel?: string | null;
+    workingDays?: number[];
+    timeZone?: string | null;
+}
+export interface PutWorkingCalendarExceptionInput {
+    /** YYYY-MM-DD */
+    date: string;
+    /** Default false (a non-working day); true is a make-up working day. */
+    working?: boolean;
+    reason: string;
+}
 //# sourceMappingURL=types.d.ts.map