@campfire-interactive/master-data-client 5.14.0 → 5.16.0

package/dist/tenantPrograms.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantProgramResource = void 0;
+/**
+ * The tenant's own programs ("Campfire Programs") at /v1/tenant-programs.
+ * `client.programs` is the LEGACY program and is unchanged; these take the
+ * plain name once legacy is gone (nextgen plan
+ * 2026-10-08-tenant-programs-pm-first.md).
+ */
+class TenantProgramResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    async list(options) {
+        const query = {};
+        if (options) {
+            if (options.limit !== undefined)
+                query.limit = String(options.limit);
+            if (options.cursor)
+                query.cursor = options.cursor;
+            if (options.sort)
+                query.sort = options.sort;
+            if (options.q)
+                query.q = options.q;
+            if (options.status)
+                query.status = options.status;
+            if (options.ids?.length)
+                query.ids = options.ids.join(',');
+            if (options.customerCompanyId)
+                query.customerCompanyId = options.customerCompanyId;
+            if (options.geographicScopeId)
+                query.geographicScopeId = options.geographicScopeId;
+            if (options.productScopeId)
+                query.productScopeId = options.productScopeId;
+            if (options.include?.length)
+                query.include = options.include.join(',');
+        }
+        return this.http.request({ method: 'GET', path: '/v1/tenant-programs', query });
+    }
+    async get(id, options) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/tenant-programs/${encodeURIComponent(id)}`,
+            query: options?.include?.length ? { include: options.include.join(',') } : {},
+        });
+    }
+    /** With `id` the program takes the caller's id; with `finishedGoods` the
+     *  lines attach in the same transaction (a refused line writes nothing). */
+    async create(input, idempotencyKey) {
+        return this.http.request({
+            method: 'POST',
+            path: '/v1/tenant-programs',
+            body: input,
+            idempotencyKey,
+        });
+    }
+    async update(id, input) {
+        return this.http.request({
+            method: 'PUT',
+            path: `/v1/tenant-programs/${encodeURIComponent(id)}`,
+            body: input,
+        });
+    }
+    /** Archive; never a hard delete. */
+    async archive(id) {
+        await this.http.request({ method: 'DELETE', path: `/v1/tenant-programs/${encodeURIComponent(id)}` });
+    }
+    async restore(id) {
+        return this.http.request({
+            method: 'POST',
+            path: `/v1/tenant-programs/${encodeURIComponent(id)}/restore`,
+        });
+    }
+    async getAudit(id) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/tenant-programs/${encodeURIComponent(id)}/audit`,
+        });
+    }
+    // ─── finished goods ────────────────────────────────────────────────────────
+    async listFinishedGoods(programId) {
+        return this.http.request({
+            method: 'GET',
+            path: `/v1/tenant-programs/${encodeURIComponent(programId)}/finished-goods`,
+        });
+    }
+    /** All lines attach or none do. */
+    async addFinishedGoods(programId, input) {
+        return this.http.request({
+            method: 'POST',
+            path: `/v1/tenant-programs/${encodeURIComponent(programId)}/finished-goods`,
+            body: input,
+        });
+    }
+    async updateFinishedGood(programId, finishedGoodId, input) {
+        return this.http.request({
+            method: 'PATCH',
+            path: `/v1/tenant-programs/${encodeURIComponent(programId)}/finished-goods/${encodeURIComponent(finishedGoodId)}`,
+            body: input,
+        });
+    }
+    async removeFinishedGood(programId, finishedGoodId) {
+        await this.http.request({
+            method: 'DELETE',
+            path: `/v1/tenant-programs/${encodeURIComponent(programId)}/finished-goods/${encodeURIComponent(finishedGoodId)}`,
+        });
+    }
+    /** The finished goods of up to 100 programs in one read. */
+    async finishedGoodsByPrograms(programIds) {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/tenant-programs/finished-goods/by-programs',
+            query: { programIds: programIds.join(',') },
+        });
+    }
+    /** Which program holds each line of a quote, or each named line. */
+    async finishedGoodsByQuote(filter) {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/tenant-programs/finished-goods',
+            query: {
+                quoteId: filter.quoteId,
+                quoteLineIds: filter.quoteLineIds?.length ? filter.quoteLineIds.join(',') : undefined,
+            },
+        });
+    }
+    /** Awarded quote lines a program can take, each annotated with its holder.
+     *  `meta.truncated` is true when more matched than `limit`. */
+    async availableAwardedLines(options) {
+        return this.http.request({
+            method: 'GET',
+            path: '/v1/tenant-programs/available-lines',
+            query: {
+                q: options?.q,
+                programId: options?.programId,
+                limit: options?.limit !== undefined ? String(options.limit) : undefined,
+            },
+        });
+    }
+}
+exports.TenantProgramResource = TenantProgramResource;
+//# sourceMappingURL=tenantPrograms.js.map

package/dist/tenantPrograms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tenantPrograms.js","sourceRoot":"","sources":["../src/tenantPrograms.ts"],"names":[],"mappings":";;;AAmBA;;;;;GAKG;AACH,MAAa,qBAAqB;IACH;IAA7B,YAA6B,IAAmB;QAAnB,SAAI,GAAJ,IAAI,CAAe;IAAG,CAAC;IAEpD,KAAK,CAAC,IAAI,CAAC,OAAmC;QAC5C,MAAM,KAAK,GAAuC,EAAE,CAAC;QACrD,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,OAAO,CAAC,KAAK,KAAK,SAAS;gBAAE,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACrE,IAAI,OAAO,CAAC,MAAM;gBAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAClD,IAAI,OAAO,CAAC,IAAI;gBAAE,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;YAC5C,IAAI,OAAO,CAAC,CAAC;gBAAE,KAAK,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YACnC,IAAI,OAAO,CAAC,MAAM;gBAAE,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAClD,IAAI,OAAO,CAAC,GAAG,EAAE,MAAM;gBAAE,KAAK,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC3D,IAAI,OAAO,CAAC,iBAAiB;gBAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;YACnF,IAAI,OAAO,CAAC,iBAAiB;gBAAE,KAAK,CAAC,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;YACnF,IAAI,OAAO,CAAC,cAAc;gBAAE,KAAK,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;YAC1E,IAAI,OAAO,CAAC,OAAO,EAAE,MAAM;gBAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACzE,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA8B,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,CAAC,CAAC;IAC/G,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,EAAU,EAAE,OAAiC;QACrD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE;YACrD,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE;SAC9E,CAAC,CAAC;IACL,CAAC;IAED;gFAC4E;IAC5E,KAAK,CAAC,MAAM,CAAC,KAA+B,EAAE,cAAuB;QACnE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,KAAK;YACX,cAAc;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,KAA+B;QACtD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE;YACrD,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,oCAAoC;IACpC,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IAClH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAgC;YACtD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,UAAU;SAC9D,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,EAAU;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA4B;YAClD,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,EAAE,CAAC,QAAQ;SAC5D,CAAC,CAAC;IACL,CAAC;IAED,8EAA8E;IAE9E,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAwC;YAC9D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,SAAS,CAAC,iBAAiB;SAC5E,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,KAAK,CAAC,gBAAgB,CACpB,SAAiB,EACjB,KAAyC;QAEzC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAwC;YAC9D,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,SAAS,CAAC,iBAAiB;YAC3E,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,SAAiB,EACjB,cAAsB,EACtB,KAA2C;QAE3C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsC;YAC5D,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,SAAS,CAAC,mBAAmB,kBAAkB,CAAC,cAAc,CAAC,EAAE;YACjH,IAAI,EAAE,KAAK;SACZ,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,SAAiB,EAAE,cAAsB;QAChE,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAY;YACjC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,uBAAuB,kBAAkB,CAAC,SAAS,CAAC,mBAAmB,kBAAkB,CAAC,cAAc,CAAC,EAAE;SAClH,CAAC,CAAC;IACL,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,uBAAuB,CAAC,UAAoB;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAwC;YAC9D,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gDAAgD;YACtD,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAED,oEAAoE;IACpE,KAAK,CAAC,oBAAoB,CACxB,MAAqD;QAErD,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAA8C;YACpE,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,oCAAoC;YAC1C,KAAK,EAAE;gBACL,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;aACtF;SACF,CAAC,CAAC;IACL,CAAC;IAED;mEAC+D;IAC/D,KAAK,CAAC,qBAAqB,CACzB,OAA0C;QAE1C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAiE;YACvF,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qCAAqC;YAC3C,KAAK,EAAE;gBACL,CAAC,EAAE,OAAO,EAAE,CAAC;gBACb,SAAS,EAAE,OAAO,EAAE,SAAS;gBAC7B,KAAK,EAAE,OAAO,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;aACxE;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAhJD,sDAgJC"}

package/dist/types.d.ts

@@ -48,6 +48,10 @@ export interface Location {
     createdAt: string;
     updatedAt: string;
 }
+/** LEGACY: the old program (master-data table `programs_legacy`), in practice
+ *  an OEM's vehicle program scoped to one customer. Unchanged on the wire for
+ *  the apps still on it; the tenant's own program is {@link TenantProgram}
+ *  (`client.tenantPrograms`). */
 export interface Program {
     id: string;
     tenantId: string;
@@ -124,6 +128,153 @@ export interface ListProgramsOptions {
 export interface GetProgramOptions {
     include?: ('customerCompany' | 'oemCompany')[];
 }
+export interface TenantProgram {
+    id: string;
+    tenantId: string;
+    code: string;
+    name: string;
+    description: string | null;
+    status: 'active' | 'archived';
+    geographicScopeId: string | null;
+    productScopeId: string | null;
+    /** Custom attribute values (entity type 'program'). */
+    attributes: Record<string, unknown>;
+    /** Distinct customers of the finished goods' quotes, in attach order. */
+    customerCompanyIds: string[];
+    /** With include=customerCompanies. */
+    customerCompanies?: unknown[];
+    finishedGoodCount: number;
+    /** With include=finishedGoods (get), and on a create that attached some. */
+    finishedGoods?: TenantProgramFinishedGood[];
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ListTenantProgramsOptions {
+    limit?: number;
+    cursor?: string;
+    /** name | code | createdAt | updatedAt, '-' prefix for descending. */
+    sort?: string;
+    q?: string;
+    status?: 'active' | 'archived' | 'all';
+    /** Any status, at most 200. */
+    ids?: string[];
+    /** Programs with a finished good for this customer. */
+    customerCompanyId?: string;
+    geographicScopeId?: string;
+    productScopeId?: string;
+    include?: 'customerCompanies'[];
+}
+export interface GetTenantProgramOptions {
+    include?: ('finishedGoods' | 'customerCompanies')[];
+}
+export interface CreateTenantProgramInput {
+    /** Caller-chosen id (a UUID); pm keeps its lifecycle rows under it. */
+    id?: string;
+    name: string;
+    /** Unique in the tenant. */
+    code: string;
+    description?: string | null;
+    geographicScopeId?: string | null;
+    productScopeId?: string | null;
+    attributes?: Record<string, unknown>;
+    /** Attached in the same transaction; a refused line writes nothing. */
+    finishedGoods?: AddTenantProgramFinishedGoodsInput;
+}
+export interface UpdateTenantProgramInput {
+    name?: string;
+    code?: string;
+    description?: string | null;
+    geographicScopeId?: string | null;
+    productScopeId?: string | null;
+}
+/** One awarded quote line on a tenant program. A line sits on at most one
+ *  program. Lifecycle (status, gates) is pm's. Decimals are strings. */
+export interface TenantProgramFinishedGood {
+    id: string;
+    tenantId: string;
+    programId: string;
+    /** Null once the quote or line is wiped; the snapshot below survives. */
+    quoteId: string | null;
+    quoteLineId: string | null;
+    partId: string | null;
+    partNumber: string;
+    /** The catalog part's name, when the line is cataloged. */
+    partName: string | null;
+    plantId: string | null;
+    sopDate: string | null;
+    eopDate: string | null;
+    awardedUnitPrice: string | null;
+    awardedAnnualVolume: string | null;
+    awardedLifetimeRevenue: string | null;
+    awardedMarginPct: string | null;
+    awardedCurrency: string | null;
+    quote: {
+        id: string;
+        quoteNumber: string;
+        name: string | null;
+        customerCompanyId: string;
+    } | null;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AddTenantProgramFinishedGoodsInput {
+    /** Lines of awarded quotes, at most 200; all attach or none do. */
+    quoteLineIds: string[];
+    /** One plant for every line in this call. */
+    plantId?: string | null;
+    /** Override the quote's SOP/EOP for every line in this call. */
+    sopDate?: string | null;
+    eopDate?: string | null;
+    /** The id each new finished good takes, keyed by quote line id; a line
+     *  without one gets a generated id. A taken id is a 409. */
+    idsByQuoteLineId?: Record<string, string>;
+}
+export interface UpdateTenantProgramFinishedGoodInput {
+    plantId?: string | null;
+    sopDate?: string | null;
+    eopDate?: string | null;
+}
+/** A finished good with the program holding it, from the by-quote lookup. */
+export interface TenantProgramFinishedGoodHolder extends Omit<TenantProgramFinishedGood, 'partName' | 'quote'> {
+    program: {
+        id: string;
+        name: string;
+        code: string;
+        status: 'active' | 'archived';
+    };
+}
+/** An awarded quote line, annotated with the program already holding it. */
+export interface AvailableAwardedLine {
+    quoteLineId: string;
+    partId: string | null;
+    partNumber: string;
+    partName: string | null;
+    unitPrice: string | null;
+    annualVolume: string | null;
+    quoteId: string;
+    quoteNumber: string;
+    quoteName: string | null;
+    customerCompanyId: string;
+    sopDate: string | null;
+    eopDate: string | null;
+    currency: string;
+    takenByProgramId: string | null;
+    takenByProgramCode: string | null;
+    /** True when held by the programId passed to the query. */
+    onThisProgram: boolean;
+}
+export interface ListAvailableAwardedLinesOptions {
+    /** Part number, part name, quote number or quote name; omitted = newest. */
+    q?: string;
+    /** Marks lines already on this program (onThisProgram). */
+    programId?: string;
+    /** 1-200, default 50. */
+    limit?: number;
+}
 export type QuoteStatus = 'draft' | 'costing_requested' | 'costing_in_progress' | 'costing_complete' | 'pricing' | 'routed_for_approval' | 'in_review' | 'approved' | 'submitted' | 'negotiating' | 'awarded' | 'lost' | 'not_taken';
 /**
  * Who is driving the transition. Required on every status update so the
@@ -3764,6 +3915,22 @@ export interface MasterDataClientConfig {
     timeout?: number;
     /** When set, sends X-Target-Tenant header on every request (platform tenant override). */
     targetTenantId?: string;
+    /**
+     * Retry on 429 Too Many Requests and 503 Service Unavailable — the hub's (and
+     * its API gateway's) answers for load. On by default; `false` turns it off.
+     * Exponential backoff with full jitter, honoring a `Retry-After` header when
+     * one is sent. A write is retried with the SAME Idempotency-Key, which the
+     * hub honors, so a retry can never apply a mutation twice. Timeouts and
+     * network errors are NOT retried: the server's state is unknown there.
+     */
+    retry?: false | {
+        /** Retries after the first attempt. Default 4. */
+        maxRetries?: number;
+        /** First backoff ceiling in ms; doubles each retry. Default 250. */
+        baseDelayMs?: number;
+        /** Largest single wait in ms, Retry-After included. Default 8000. */
+        maxDelayMs?: number;
+    };
 }
 export type QuoteDocumentStage = 'feasibility' | 'award';
 /** Quote-level (one document for the quote) or one per finished good. The