@aglyn/plugins-commerce 1.0.0-beta.289 → 1.0.0-beta.291

package/src/lib/model/commerce-quote-request.js

@@ -0,0 +1,207 @@
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ import { _ as _extends } from "@swc/helpers/_/_extends";
+/*==========================================
+ * A QUOTE STARTED FROM A REQUEST (AGL-4098).
+ *
+ * A "Request a quote" form sends a submission the forms plugin keeps; the
+ * Inbox shows it, and this plugin answers it with a quote. Neither plugin
+ * imports the other: the request is read through the core's record-facts
+ * seam ({@link QUOTE_REQUEST_FACTS_RESOURCE}, the forms plugin's reader), and
+ * the product a customer picked rides the submission as plain strings the
+ * Product and options field posted ({@link parseProductFieldValue}).
+ *
+ * What a quote takes from a request, all of it server-read:
+ *
+ *  - the CUSTOMER: name, email, phone and company, as the form gave them;
+ *  - a LINE for the product and its options, when the form had the field;
+ *  - the NOTES: the request's own words;
+ *  - its FILES, kept where the request keeps them and listed on the quote as
+ *    the customer's files (`quote.requestFiles`), downloaded through the
+ *    quote's own gated route;
+ *  - the REQUEST itself (`quote.request`): which submission, which form, when;
+ *  - the CONVERSATION (`quote.emailThread`): the thread the request's
+ *    confirmation email started, so the quote's first email replies into it.
+ *=========================================*/ /** The resource the forms plugin reads a submission's facts under, on the core's seam. */ export const QUOTE_REQUEST_FACTS_RESOURCE = 'forms.submission';
+const ID = /^(?!__.*__$)[^/]{1,200}$/;
+const MAX_OPTIONS = 20;
+const MAX_MODIFIERS = 50;
+const text = (value, max = 200)=>typeof value === 'string' ? value.trim().slice(0, max) : '';
+/** The compact value the field posts. */ export function encodeProductFieldValue(value) {
+    var _value_modifiers;
+    return JSON.stringify(_extends({
+        productId: value.productId
+    }, value.variantId ? {
+        variantId: value.variantId
+    } : {}, value.options && Object.keys(value.options).length ? {
+        options: value.options
+    } : {}, ((_value_modifiers = value.modifiers) == null ? void 0 : _value_modifiers.length) ? {
+        modifiers: value.modifiers
+    } : {}));
+}
+/**
+ * The field's posted value, read back, or null for anything that is not one:
+ * malformed JSON, no product id, ids that cannot be document ids. The options
+ * keep at most twenty names and values of up to 200 characters.
+ */ export function parseProductFieldValue(raw) {
+    if (typeof raw !== 'string' || !raw.trim() || raw.length > 4000) return null;
+    let parsed;
+    try {
+        parsed = JSON.parse(raw);
+    } catch (unused) {
+        return null;
+    }
+    if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) return null;
+    const source = parsed;
+    const productId = text(source['productId']);
+    if (!ID.test(productId)) return null;
+    const variantId = text(source['variantId']);
+    const options = {};
+    const rawOptions = source['options'];
+    if (rawOptions && typeof rawOptions === 'object' && !Array.isArray(rawOptions)) {
+        for (const [name, value] of Object.entries(rawOptions).slice(0, MAX_OPTIONS)){
+            const key = text(name);
+            const picked = text(value);
+            if (key && picked) options[key] = picked;
+        }
+    }
+    const modifiers = Array.isArray(source['modifiers']) ? source['modifiers'].slice(0, MAX_MODIFIERS).map((entry)=>{
+        const pick = entry != null ? entry : {};
+        return {
+            groupId: text(pick['groupId']),
+            optionId: text(pick['optionId'])
+        };
+    }).filter((pick)=>pick.groupId && pick.optionId) : [];
+    return _extends({
+        productId
+    }, variantId && ID.test(variantId) ? {
+        variantId
+    } : {}, Object.keys(options).length ? {
+        options
+    } : {}, modifiers.length ? {
+        modifiers
+    } : {});
+}
+/** The readable line the field posts under its name: the product, then its options. */ export function productFieldLabel(productName, options) {
+    const picked = Object.values(options != null ? options : {}).filter(Boolean);
+    return picked.length ? `${productName} — ${picked.join(' / ')}` : productName;
+}
+/** A request's facts as the seam answered them, read defensively. */ export function readQuoteRequestFacts(raw) {
+    var _raw_person, _raw_request, _raw_emailThread, _raw_capturedRecord, _raw_fieldData;
+    if (!raw || raw['record'] !== 'formSubmission') return null;
+    const person = (_raw_person = raw['person']) != null ? _raw_person : {};
+    const request = (_raw_request = raw['request']) != null ? _raw_request : null;
+    const files = Array.isArray(raw['files']) ? raw['files'] : [];
+    const thread = (_raw_emailThread = raw['emailThread']) != null ? _raw_emailThread : null;
+    const captured = (_raw_capturedRecord = raw['capturedRecord']) != null ? _raw_capturedRecord : null;
+    const references = Array.isArray(thread == null ? void 0 : thread['references']) ? (thread == null ? void 0 : thread['references']).map(String) : [];
+    return {
+        hostId: text(raw['hostId']),
+        formName: text(raw['formName']) || 'Form',
+        createdAtMs: typeof raw['createdAtMs'] === 'number' ? raw['createdAtMs'] : null,
+        requestKind: typeof (request == null ? void 0 : request.kind) === 'string' ? request.kind : null,
+        person: {
+            name: text(person['name']),
+            email: text(person['email']),
+            phone: text(person['phone'], 40),
+            company: text(person['company'])
+        },
+        capturedRecord: ((captured == null ? void 0 : captured.kind) === 'lead' || (captured == null ? void 0 : captured.kind) === 'contact') && ID.test(text(captured.id)) ? {
+            kind: captured.kind,
+            id: text(captured.id)
+        } : null,
+        message: text(raw['message'], 5000),
+        fieldData: Object.fromEntries(Object.entries((_raw_fieldData = raw['fieldData']) != null ? _raw_fieldData : {}).filter((entry)=>typeof entry[1] === 'string').map(([key, value])=>[
+                key,
+                value.slice(0, 4000)
+            ])),
+        files: files.slice(0, 10).flatMap((entry)=>{
+            const file = entry != null ? entry : {};
+            const id = text(file['id'], 128);
+            const path = text(file['path'], 500);
+            if (!id || !path.startsWith('hosts/') || !text(file['name'])) return [];
+            return [
+                {
+                    id,
+                    name: text(file['name']),
+                    contentType: text(file['contentType'], 100),
+                    size: Number(file['size']) || 0,
+                    path
+                }
+            ];
+        }),
+        emailThread: thread && typeof thread['messageId'] === 'string' && typeof thread['subject'] === 'string' ? {
+            messageId: thread['messageId'],
+            references,
+            subject: thread['subject']
+        } : null
+    };
+}
+/** The product lines a request's Product and options fields ask for, one per field. */ export function quoteLinesFromFieldData(fieldData) {
+    const lines = [];
+    for (const raw of Object.values(fieldData)){
+        var _value_modifiers;
+        const value = parseProductFieldValue(raw);
+        if (!value) continue;
+        lines.push(_extends({
+            kind: 'catalog',
+            productId: value.productId
+        }, value.variantId ? {
+            variantId: value.variantId
+        } : {}, {
+            quantity: 1
+        }, ((_value_modifiers = value.modifiers) == null ? void 0 : _value_modifiers.length) ? {
+            modifiers: value.modifiers
+        } : {}));
+    }
+    return lines;
+}
+/** A quote's start from a request: the editor's prefill, and what the server stamps on the quote. */ export function quoteStartFromRequest(submissionId, facts) {
+    return {
+        prefill: {
+            customer: _extends({}, facts.capturedRecord ? {
+                record: facts.capturedRecord
+            } : {}, facts.person.name ? {
+                name: facts.person.name
+            } : {}, facts.person.email ? {
+                email: facts.person.email
+            } : {}, facts.person.phone ? {
+                phone: facts.person.phone
+            } : {}, facts.person.company ? {
+                company: facts.person.company
+            } : {}),
+            lines: quoteLinesFromFieldData(facts.fieldData),
+            notes: facts.message
+        },
+        request: {
+            submissionId,
+            formName: facts.formName,
+            receivedAtMs: facts.createdAtMs
+        },
+        files: facts.files,
+        emailThread: facts.emailThread
+    };
+}
+/** A request's files as the console may see them: no storage path. */ export function quoteRequestFileViews(files) {
+    return (files != null ? files : []).map(({ id, name, contentType, size })=>({
+            id,
+            name,
+            contentType,
+            size
+        }));
+}
+
+//# sourceMappingURL=commerce-quote-request.js.map

package/src/lib/model/commerce-quote-request.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/commerce/src/lib/model/commerce-quote-request.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { QuoteCatalogLineRequest, QuoteCustomer, QuoteEmailThread, QuoteResponseFile } from './commerce-quotes'\n\n/*==========================================\n * A QUOTE STARTED FROM A REQUEST (AGL-4098).\n *\n * A \"Request a quote\" form sends a submission the forms plugin keeps; the\n * Inbox shows it, and this plugin answers it with a quote. Neither plugin\n * imports the other: the request is read through the core's record-facts\n * seam ({@link QUOTE_REQUEST_FACTS_RESOURCE}, the forms plugin's reader), and\n * the product a customer picked rides the submission as plain strings the\n * Product and options field posted ({@link parseProductFieldValue}).\n *\n * What a quote takes from a request, all of it server-read:\n *\n *  - the CUSTOMER: name, email, phone and company, as the form gave them;\n *  - a LINE for the product and its options, when the form had the field;\n *  - the NOTES: the request's own words;\n *  - its FILES, kept where the request keeps them and listed on the quote as\n *    the customer's files (`quote.requestFiles`), downloaded through the\n *    quote's own gated route;\n *  - the REQUEST itself (`quote.request`): which submission, which form, when;\n *  - the CONVERSATION (`quote.emailThread`): the thread the request's\n *    confirmation email started, so the quote's first email replies into it.\n *=========================================*/\n\n/** The resource the forms plugin reads a submission's facts under, on the core's seam. */\nexport const QUOTE_REQUEST_FACTS_RESOURCE = 'forms.submission'\n\n/** The request a quote was started from. */\nexport interface QuoteRequestRef {\n  submissionId: string\n  formName: string\n  /** When the request arrived, epoch ms; null when the submission did not say. */\n  receivedAtMs: number | null\n}\n\n/**\n * What the Product and options field posts beside its readable line, under\n * `{name}__data`: the product, the variant the options make, and the options\n * as picked. Add-ons are not taken from the storefront yet; when they are,\n * they ride here as `modifiers` and the quote line prices them as the editor\n * does.\n */\nexport interface ProductFieldValue {\n  productId: string\n  variantId?: string\n  options?: Record<string, string>\n  modifiers?: Array<{ groupId: string; optionId: string }>\n}\n\nconst ID = /^(?!__.*__$)[^/]{1,200}$/\nconst MAX_OPTIONS = 20\nconst MAX_MODIFIERS = 50\n\nconst text = (value: unknown, max = 200): string => (typeof value === 'string' ? value.trim().slice(0, max) : '')\n\n/** The compact value the field posts. */\nexport function encodeProductFieldValue(value: ProductFieldValue): string {\n  return JSON.stringify({\n    productId: value.productId,\n    ...(value.variantId ? { variantId: value.variantId } : {}),\n    ...(value.options && Object.keys(value.options).length ? { options: value.options } : {}),\n    ...(value.modifiers?.length ? { modifiers: value.modifiers } : {}),\n  })\n}\n\n/**\n * The field's posted value, read back, or null for anything that is not one:\n * malformed JSON, no product id, ids that cannot be document ids. The options\n * keep at most twenty names and values of up to 200 characters.\n */\nexport function parseProductFieldValue(raw: unknown): ProductFieldValue | null {\n  if (typeof raw !== 'string' || !raw.trim() || raw.length > 4000) return null\n  let parsed: unknown\n  try {\n    parsed = JSON.parse(raw)\n  } catch {\n    return null\n  }\n  if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) return null\n  const source = parsed as Record<string, unknown>\n  const productId = text(source['productId'])\n  if (!ID.test(productId)) return null\n  const variantId = text(source['variantId'])\n  const options: Record<string, string> = {}\n  const rawOptions = source['options']\n  if (rawOptions && typeof rawOptions === 'object' && !Array.isArray(rawOptions)) {\n    for (const [name, value] of Object.entries(rawOptions as Record<string, unknown>).slice(0, MAX_OPTIONS)) {\n      const key = text(name)\n      const picked = text(value)\n      if (key && picked) options[key] = picked\n    }\n  }\n  const modifiers = Array.isArray(source['modifiers'])\n    ? (source['modifiers'] as unknown[])\n        .slice(0, MAX_MODIFIERS)\n        .map((entry) => {\n          const pick = (entry ?? {}) as Record<string, unknown>\n          return { groupId: text(pick['groupId']), optionId: text(pick['optionId']) }\n        })\n        .filter((pick) => pick.groupId && pick.optionId)\n    : []\n  return {\n    productId,\n    ...(variantId && ID.test(variantId) ? { variantId } : {}),\n    ...(Object.keys(options).length ? { options } : {}),\n    ...(modifiers.length ? { modifiers } : {}),\n  }\n}\n\n/** The readable line the field posts under its name: the product, then its options. */\nexport function productFieldLabel(productName: string, options: Record<string, string> | undefined): string {\n  const picked = Object.values(options ?? {}).filter(Boolean)\n  return picked.length ? `${productName} — ${picked.join(' / ')}` : productName\n}\n\n/** What this plugin reads of a request's facts (the forms plugin's reader documents them). */\nexport interface QuoteRequestFacts {\n  hostId: string\n  formName: string\n  createdAtMs: number | null\n  requestKind: string | null\n  person: { name: string; email: string; phone: string; company: string }\n  /** The lead or contact the request was filed as, which the quote's customer links to. */\n  capturedRecord: { kind: string; id: string } | null\n  message: string\n  fieldData: Record<string, string>\n  files: Array<QuoteResponseFile>\n  emailThread: QuoteEmailThread | null\n}\n\n/** A request's facts as the seam answered them, read defensively. */\nexport function readQuoteRequestFacts(raw: Readonly<Record<string, unknown>> | null | undefined): QuoteRequestFacts | null {\n  if (!raw || raw['record'] !== 'formSubmission') return null\n  const person = (raw['person'] ?? {}) as Record<string, unknown>\n  const request = (raw['request'] ?? null) as { kind?: unknown } | null\n  const files = Array.isArray(raw['files']) ? (raw['files'] as unknown[]) : []\n  const thread = (raw['emailThread'] ?? null) as Record<string, unknown> | null\n  const captured = (raw['capturedRecord'] ?? null) as { kind?: unknown; id?: unknown } | null\n  const references = Array.isArray(thread?.['references']) ? (thread?.['references'] as unknown[]).map(String) : []\n  return {\n    hostId: text(raw['hostId']),\n    formName: text(raw['formName']) || 'Form',\n    createdAtMs: typeof raw['createdAtMs'] === 'number' ? raw['createdAtMs'] : null,\n    requestKind: typeof request?.kind === 'string' ? request.kind : null,\n    person: {\n      name: text(person['name']),\n      email: text(person['email']),\n      phone: text(person['phone'], 40),\n      company: text(person['company']),\n    },\n    capturedRecord:\n      (captured?.kind === 'lead' || captured?.kind === 'contact') && ID.test(text(captured.id))\n        ? { kind: captured.kind, id: text(captured.id) }\n        : null,\n    message: text(raw['message'], 5000),\n    fieldData: Object.fromEntries(\n      Object.entries((raw['fieldData'] ?? {}) as Record<string, unknown>)\n        .filter((entry): entry is [string, string] => typeof entry[1] === 'string')\n        .map(([key, value]) => [key, value.slice(0, 4000)]),\n    ),\n    files: files.slice(0, 10).flatMap((entry) => {\n      const file = (entry ?? {}) as Record<string, unknown>\n      const id = text(file['id'], 128)\n      const path = text(file['path'], 500)\n      if (!id || !path.startsWith('hosts/') || !text(file['name'])) return []\n      return [\n        {\n          id,\n          name: text(file['name']),\n          contentType: text(file['contentType'], 100),\n          size: Number(file['size']) || 0,\n          path,\n        },\n      ]\n    }),\n    emailThread:\n      thread && typeof thread['messageId'] === 'string' && typeof thread['subject'] === 'string'\n        ? { messageId: thread['messageId'], references, subject: thread['subject'] }\n        : null,\n  }\n}\n\n/** What the quote editor opens with when a quote is started from a request. */\nexport interface QuoteStartPrefill {\n  customer: Pick<QuoteCustomer, 'record' | 'name' | 'email' | 'phone' | 'company'>\n  lines: QuoteCatalogLineRequest[]\n  notes: string\n}\n\n/** The product lines a request's Product and options fields ask for, one per field. */\nexport function quoteLinesFromFieldData(fieldData: Readonly<Record<string, string>>): QuoteCatalogLineRequest[] {\n  const lines: QuoteCatalogLineRequest[] = []\n  for (const raw of Object.values(fieldData)) {\n    const value = parseProductFieldValue(raw)\n    if (!value) continue\n    lines.push({\n      kind: 'catalog',\n      productId: value.productId,\n      ...(value.variantId ? { variantId: value.variantId } : {}),\n      quantity: 1,\n      ...(value.modifiers?.length ? { modifiers: value.modifiers } : {}),\n    })\n  }\n  return lines\n}\n\n/** A quote's start from a request: the editor's prefill, and what the server stamps on the quote. */\nexport function quoteStartFromRequest(\n  submissionId: string,\n  facts: QuoteRequestFacts,\n): {\n  prefill: QuoteStartPrefill\n  request: QuoteRequestRef\n  files: QuoteResponseFile[]\n  emailThread: QuoteEmailThread | null\n} {\n  return {\n    prefill: {\n      customer: {\n        ...(facts.capturedRecord ? { record: facts.capturedRecord } : {}),\n        ...(facts.person.name ? { name: facts.person.name } : {}),\n        ...(facts.person.email ? { email: facts.person.email } : {}),\n        ...(facts.person.phone ? { phone: facts.person.phone } : {}),\n        ...(facts.person.company ? { company: facts.person.company } : {}),\n      },\n      lines: quoteLinesFromFieldData(facts.fieldData),\n      notes: facts.message,\n    },\n    request: { submissionId, formName: facts.formName, receivedAtMs: facts.createdAtMs },\n    files: facts.files,\n    emailThread: facts.emailThread,\n  }\n}\n\n/** A request's files as the console may see them: no storage path. */\nexport function quoteRequestFileViews(files: readonly QuoteResponseFile[] | null | undefined): Array<Omit<QuoteResponseFile, 'path'>> {\n  return (files ?? []).map(({ id, name, contentType, size }) => ({ id, name, contentType, size }))\n}\n"],"names":["QUOTE_REQUEST_FACTS_RESOURCE","ID","MAX_OPTIONS","MAX_MODIFIERS","text","value","max","trim","slice","encodeProductFieldValue","JSON","stringify","productId","variantId","options","Object","keys","length","modifiers","parseProductFieldValue","raw","parsed","parse","Array","isArray","source","test","rawOptions","name","entries","key","picked","map","entry","pick","groupId","optionId","filter","productFieldLabel","productName","values","Boolean","join","readQuoteRequestFacts","person","request","files","thread","captured","references","String","hostId","formName","createdAtMs","requestKind","kind","email","phone","company","capturedRecord","id","message","fieldData","fromEntries","flatMap","file","path","startsWith","contentType","size","Number","emailThread","messageId","subject","quoteLinesFromFieldData","lines","push","quantity","quoteStartFromRequest","submissionId","facts","prefill","customer","record","notes","receivedAtMs","quoteRequestFileViews"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC;AAID;;;;;;;;;;;;;;;;;;;;;2CAqB2C,GAE3C,wFAAwF,GACxF,OAAO,MAAMA,+BAA+B,mBAAkB;AAwB9D,MAAMC,KAAK;AACX,MAAMC,cAAc;AACpB,MAAMC,gBAAgB;AAEtB,MAAMC,OAAO,CAACC,OAAgBC,MAAM,GAAG,GAAc,OAAOD,UAAU,WAAWA,MAAME,IAAI,GAAGC,KAAK,CAAC,GAAGF,OAAO;AAE9G,uCAAuC,GACvC,OAAO,SAASG,wBAAwBJ,KAAwB;QAKxDA;IAJN,OAAOK,KAAKC,SAAS,CAAC;QACpBC,WAAWP,MAAMO,SAAS;OACtBP,MAAMQ,SAAS,GAAG;QAAEA,WAAWR,MAAMQ,SAAS;IAAC,IAAI,CAAC,GACpDR,MAAMS,OAAO,IAAIC,OAAOC,IAAI,CAACX,MAAMS,OAAO,EAAEG,MAAM,GAAG;QAAEH,SAAST,MAAMS,OAAO;IAAC,IAAI,CAAC,GACnFT,EAAAA,mBAAAA,MAAMa,SAAS,qBAAfb,iBAAiBY,MAAM,IAAG;QAAEC,WAAWb,MAAMa,SAAS;IAAC,IAAI,CAAC;AAEpE;AAEA;;;;CAIC,GACD,OAAO,SAASC,uBAAuBC,GAAY;IACjD,IAAI,OAAOA,QAAQ,YAAY,CAACA,IAAIb,IAAI,MAAMa,IAAIH,MAAM,GAAG,MAAM,OAAO;IACxE,IAAII;IACJ,IAAI;QACFA,SAASX,KAAKY,KAAK,CAACF;IACtB,EAAE,eAAM;QACN,OAAO;IACT;IACA,IAAI,CAACC,UAAU,OAAOA,WAAW,YAAYE,MAAMC,OAAO,CAACH,SAAS,OAAO;IAC3E,MAAMI,SAASJ;IACf,MAAMT,YAAYR,KAAKqB,MAAM,CAAC,YAAY;IAC1C,IAAI,CAACxB,GAAGyB,IAAI,CAACd,YAAY,OAAO;IAChC,MAAMC,YAAYT,KAAKqB,MAAM,CAAC,YAAY;IAC1C,MAAMX,UAAkC,CAAC;IACzC,MAAMa,aAAaF,MAAM,CAAC,UAAU;IACpC,IAAIE,cAAc,OAAOA,eAAe,YAAY,CAACJ,MAAMC,OAAO,CAACG,aAAa;QAC9E,KAAK,MAAM,CAACC,MAAMvB,MAAM,IAAIU,OAAOc,OAAO,CAACF,YAAuCnB,KAAK,CAAC,GAAGN,aAAc;YACvG,MAAM4B,MAAM1B,KAAKwB;YACjB,MAAMG,SAAS3B,KAAKC;YACpB,IAAIyB,OAAOC,QAAQjB,OAAO,CAACgB,IAAI,GAAGC;QACpC;IACF;IACA,MAAMb,YAAYK,MAAMC,OAAO,CAACC,MAAM,CAAC,YAAY,IAC/C,AAACA,MAAM,CAAC,YAAY,CACjBjB,KAAK,CAAC,GAAGL,eACT6B,GAAG,CAAC,CAACC;QACJ,MAAMC,OAAQD,gBAAAA,QAAS,CAAC;QACxB,OAAO;YAAEE,SAAS/B,KAAK8B,IAAI,CAAC,UAAU;YAAGE,UAAUhC,KAAK8B,IAAI,CAAC,WAAW;QAAE;IAC5E,GACCG,MAAM,CAAC,CAACH,OAASA,KAAKC,OAAO,IAAID,KAAKE,QAAQ,IACjD,EAAE;IACN,OAAO;QACLxB;OACIC,aAAaZ,GAAGyB,IAAI,CAACb,aAAa;QAAEA;IAAU,IAAI,CAAC,GACnDE,OAAOC,IAAI,CAACF,SAASG,MAAM,GAAG;QAAEH;IAAQ,IAAI,CAAC,GAC7CI,UAAUD,MAAM,GAAG;QAAEC;IAAU,IAAI,CAAC;AAE5C;AAEA,qFAAqF,GACrF,OAAO,SAASoB,kBAAkBC,WAAmB,EAAEzB,OAA2C;IAChG,MAAMiB,SAAShB,OAAOyB,MAAM,CAAC1B,kBAAAA,UAAW,CAAC,GAAGuB,MAAM,CAACI;IACnD,OAAOV,OAAOd,MAAM,GAAG,GAAGsB,YAAY,GAAG,EAAER,OAAOW,IAAI,CAAC,QAAQ,GAAGH;AACpE;AAiBA,mEAAmE,GACnE,OAAO,SAASI,sBAAsBvB,GAAyD;QAE7EA,aACCA,cAEDA,kBACEA,qBAmBEA;IAxBpB,IAAI,CAACA,OAAOA,GAAG,CAAC,SAAS,KAAK,kBAAkB,OAAO;IACvD,MAAMwB,UAAUxB,cAAAA,GAAG,CAAC,SAAS,YAAbA,cAAiB,CAAC;IAClC,MAAMyB,WAAWzB,eAAAA,GAAG,CAAC,UAAU,YAAdA,eAAkB;IACnC,MAAM0B,QAAQvB,MAAMC,OAAO,CAACJ,GAAG,CAAC,QAAQ,IAAKA,GAAG,CAAC,QAAQ,GAAiB,EAAE;IAC5E,MAAM2B,UAAU3B,mBAAAA,GAAG,CAAC,cAAc,YAAlBA,mBAAsB;IACtC,MAAM4B,YAAY5B,sBAAAA,GAAG,CAAC,iBAAiB,YAArBA,sBAAyB;IAC3C,MAAM6B,aAAa1B,MAAMC,OAAO,CAACuB,0BAAAA,MAAQ,CAAC,aAAa,IAAI,CAACA,0BAAAA,MAAQ,CAAC,aAAa,EAAef,GAAG,CAACkB,UAAU,EAAE;IACjH,OAAO;QACLC,QAAQ/C,KAAKgB,GAAG,CAAC,SAAS;QAC1BgC,UAAUhD,KAAKgB,GAAG,CAAC,WAAW,KAAK;QACnCiC,aAAa,OAAOjC,GAAG,CAAC,cAAc,KAAK,WAAWA,GAAG,CAAC,cAAc,GAAG;QAC3EkC,aAAa,QAAOT,2BAAAA,QAASU,IAAI,MAAK,WAAWV,QAAQU,IAAI,GAAG;QAChEX,QAAQ;YACNhB,MAAMxB,KAAKwC,MAAM,CAAC,OAAO;YACzBY,OAAOpD,KAAKwC,MAAM,CAAC,QAAQ;YAC3Ba,OAAOrD,KAAKwC,MAAM,CAAC,QAAQ,EAAE;YAC7Bc,SAAStD,KAAKwC,MAAM,CAAC,UAAU;QACjC;QACAe,gBACE,AAACX,CAAAA,CAAAA,4BAAAA,SAAUO,IAAI,MAAK,UAAUP,CAAAA,4BAAAA,SAAUO,IAAI,MAAK,SAAQ,KAAMtD,GAAGyB,IAAI,CAACtB,KAAK4C,SAASY,EAAE,KACnF;YAAEL,MAAMP,SAASO,IAAI;YAAEK,IAAIxD,KAAK4C,SAASY,EAAE;QAAE,IAC7C;QACNC,SAASzD,KAAKgB,GAAG,CAAC,UAAU,EAAE;QAC9B0C,WAAW/C,OAAOgD,WAAW,CAC3BhD,OAAOc,OAAO,EAAET,iBAAAA,GAAG,CAAC,YAAY,YAAhBA,iBAAoB,CAAC,GAClCiB,MAAM,CAAC,CAACJ,QAAqC,OAAOA,KAAK,CAAC,EAAE,KAAK,UACjED,GAAG,CAAC,CAAC,CAACF,KAAKzB,MAAM,GAAK;gBAACyB;gBAAKzB,MAAMG,KAAK,CAAC,GAAG;aAAM;QAEtDsC,OAAOA,MAAMtC,KAAK,CAAC,GAAG,IAAIwD,OAAO,CAAC,CAAC/B;YACjC,MAAMgC,OAAQhC,gBAAAA,QAAS,CAAC;YACxB,MAAM2B,KAAKxD,KAAK6D,IAAI,CAAC,KAAK,EAAE;YAC5B,MAAMC,OAAO9D,KAAK6D,IAAI,CAAC,OAAO,EAAE;YAChC,IAAI,CAACL,MAAM,CAACM,KAAKC,UAAU,CAAC,aAAa,CAAC/D,KAAK6D,IAAI,CAAC,OAAO,GAAG,OAAO,EAAE;YACvE,OAAO;gBACL;oBACEL;oBACAhC,MAAMxB,KAAK6D,IAAI,CAAC,OAAO;oBACvBG,aAAahE,KAAK6D,IAAI,CAAC,cAAc,EAAE;oBACvCI,MAAMC,OAAOL,IAAI,CAAC,OAAO,KAAK;oBAC9BC;gBACF;aACD;QACH;QACAK,aACExB,UAAU,OAAOA,MAAM,CAAC,YAAY,KAAK,YAAY,OAAOA,MAAM,CAAC,UAAU,KAAK,WAC9E;YAAEyB,WAAWzB,MAAM,CAAC,YAAY;YAAEE;YAAYwB,SAAS1B,MAAM,CAAC,UAAU;QAAC,IACzE;IACR;AACF;AASA,qFAAqF,GACrF,OAAO,SAAS2B,wBAAwBZ,SAA2C;IACjF,MAAMa,QAAmC,EAAE;IAC3C,KAAK,MAAMvD,OAAOL,OAAOyB,MAAM,CAACsB,WAAY;YAQpCzD;QAPN,MAAMA,QAAQc,uBAAuBC;QACrC,IAAI,CAACf,OAAO;QACZsE,MAAMC,IAAI,CAAC;YACTrB,MAAM;YACN3C,WAAWP,MAAMO,SAAS;WACtBP,MAAMQ,SAAS,GAAG;YAAEA,WAAWR,MAAMQ,SAAS;QAAC,IAAI,CAAC;YACxDgE,UAAU;WACNxE,EAAAA,mBAAAA,MAAMa,SAAS,qBAAfb,iBAAiBY,MAAM,IAAG;YAAEC,WAAWb,MAAMa,SAAS;QAAC,IAAI,CAAC;IAEpE;IACA,OAAOyD;AACT;AAEA,mGAAmG,GACnG,OAAO,SAASG,sBACdC,YAAoB,EACpBC,KAAwB;IAOxB,OAAO;QACLC,SAAS;YACPC,UAAU,aACJF,MAAMrB,cAAc,GAAG;gBAAEwB,QAAQH,MAAMrB,cAAc;YAAC,IAAI,CAAC,GAC3DqB,MAAMpC,MAAM,CAAChB,IAAI,GAAG;gBAAEA,MAAMoD,MAAMpC,MAAM,CAAChB,IAAI;YAAC,IAAI,CAAC,GACnDoD,MAAMpC,MAAM,CAACY,KAAK,GAAG;gBAAEA,OAAOwB,MAAMpC,MAAM,CAACY,KAAK;YAAC,IAAI,CAAC,GACtDwB,MAAMpC,MAAM,CAACa,KAAK,GAAG;gBAAEA,OAAOuB,MAAMpC,MAAM,CAACa,KAAK;YAAC,IAAI,CAAC,GACtDuB,MAAMpC,MAAM,CAACc,OAAO,GAAG;gBAAEA,SAASsB,MAAMpC,MAAM,CAACc,OAAO;YAAC,IAAI,CAAC;YAElEiB,OAAOD,wBAAwBM,MAAMlB,SAAS;YAC9CsB,OAAOJ,MAAMnB,OAAO;QACtB;QACAhB,SAAS;YAAEkC;YAAc3B,UAAU4B,MAAM5B,QAAQ;YAAEiC,cAAcL,MAAM3B,WAAW;QAAC;QACnFP,OAAOkC,MAAMlC,KAAK;QAClByB,aAAaS,MAAMT,WAAW;IAChC;AACF;AAEA,oEAAoE,GACpE,OAAO,SAASe,sBAAsBxC,KAAsD;IAC1F,OAAO,CAACA,gBAAAA,QAAS,EAAE,EAAEd,GAAG,CAAC,CAAC,EAAE4B,EAAE,EAAEhC,IAAI,EAAEwC,WAAW,EAAEC,IAAI,EAAE,GAAM,CAAA;YAAET;YAAIhC;YAAMwC;YAAaC;QAAK,CAAA;AAC/F"}

package/src/lib/model/commerce-quotes.d.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 import type { HostProduct } from './commerce';
+import type { QuoteRequestRef } from './commerce-quote-request';
 import type { HostOrder, OrderAddress, OrderLineItem, OrderStatus, OrderTotals } from './commerce-orders';
 import { type TaxSettings } from './commerce-tax';
 import { type StorefrontTaxMode } from './commerce-tax-decision';
@@ -67,11 +68,60 @@ export interface QuoteTaxBasis {
     providerLabel?: string;
     reason?: QuoteNoTaxReason;
 }
-/** A proof attached to one revision of a quote. Written by the proofs feature. */
+/** A proof attached to one revision of a quote: what names it, and the revision it is for. */
 export interface QuoteProofRef {
     id: string;
     revision: number;
 }
+/**
+ * A proof the business attached to a revision (AGL-4096): an image or a
+ * design file in the site's private storage, under the quote.
+ */
+export interface QuoteProof extends QuoteProofRef {
+    name: string;
+    contentType: string;
+    size: number;
+    /** The private Storage object. Never sent to the customer. */
+    path: string;
+    addedAtMs: number;
+    /** Who attached it: an email, else a uid. */
+    addedBy: string;
+}
+/** A file the customer sent with a response. */
+export interface QuoteResponseFile {
+    id: string;
+    name: string;
+    contentType: string;
+    size: number;
+    /** The private Storage object. Never sent to the customer. */
+    path: string;
+}
+/**
+ * The customer's answer to a revision's proofs (AGL-4096): approved under a
+ * typed name, or changes asked for in a comment, with artwork if they had
+ * some. The address and browser are kept as the record of who answered.
+ */
+export interface QuoteCustomerResponse {
+    action: 'approve' | 'changes';
+    revision: number;
+    atMs: number;
+    /** With `approve`: the name they typed. */
+    name?: string;
+    /** With `changes`: what to change. */
+    comment?: string;
+    /** With `changes`: files they sent. */
+    files?: QuoteResponseFile[];
+    ip: string | null;
+    userAgent: string | null;
+}
+/** The record of a revision's approval. */
+export interface QuoteApproval {
+    revision: number;
+    name: string;
+    atMs: number;
+    ip: string | null;
+    userAgent: string | null;
+}
 /**
  * A payment that reached a quote it could not pay: one made through a pay
  * link the business replaced or for a price it has since changed
@@ -86,6 +136,73 @@ export interface QuoteUnmatchedPayment {
     atMs: number;
     reason: 'superseded' | 'already-paid';
 }
+/**
+ * The conversation the quote's emails keep in the customer's mailbox
+ * (AGL-4097): the latest message's `Message-ID`, every id in the
+ * conversation oldest first, and the subject it runs under. The shape of
+ * `EmailThread` (`@aglyn/shared-util-email`), spelled out so the model needs
+ * no email library. Started by the first email about the quote (a request's
+ * confirmation, or the quote itself); every later one replies into it.
+ */
+export interface QuoteEmailThread {
+    messageId: string;
+    references: string[];
+    subject: string;
+}
+/** One time the quote was emailed to the customer (AGL-4097). */
+export interface QuoteSendRecord {
+    /** The revision the email carried. */
+    revision: number;
+    to: string;
+    subject: string;
+    atMs: number;
+    /** Who sent it: an email, else a uid. */
+    by: string;
+    /** The `Message-ID` the email was sent with. */
+    messageId: string;
+    /** The mail provider's own id for the message, when it answered one. */
+    providerId: string | null;
+    /** The pay link version the email carried. */
+    linkVersion: number;
+}
+/** One shipping rate a draft order offered (AGL-4099), as checkout's resolved rates name it. */
+export interface OrderDraftShippingRate {
+    rateId: string;
+    name: string;
+    amountCents: number;
+}
+/** The shipping a draft order offered when it was made (AGL-4099); see `HostOrder.draftShipping`. */
+export interface OrderDraftShipping {
+    /** Where its rates ship; empty when it offers none. */
+    countries: string[];
+    /** The rates the buyer picks from at payment; empty when it ships nothing. */
+    options: OrderDraftShippingRate[];
+}
+/** The lasting pay link of an order that is not a quote (AGL-4099); see `HostOrder.payLink`. */
+export interface OrderPayLink {
+    /** The link's version, absent reading as 1. */
+    version?: number;
+    /** Payments through the link the order could not take, as a quote records them. */
+    unmatchedPayments?: QuoteUnmatchedPayment[];
+}
+/** One time an order's (or a quote's) invoice was emailed to the customer (AGL-4099). */
+export interface OrderInvoiceSendRecord {
+    to: string;
+    subject: string;
+    atMs: number;
+    /** Who sent it: an email, else a uid. */
+    by: string;
+    /** The `Message-ID` the email was sent with. */
+    messageId: string;
+    /** The mail provider's own id for the message, when it answered one. */
+    providerId: string | null;
+    /** The invoice said it was paid (the record), rather than asking for payment. */
+    paid: boolean;
+    /** The pay link version an unpaid invoice carried; null on a paid one. */
+    linkVersion: number | null;
+    /** The total the invoice showed. */
+    totalCents: number;
+}
 /** What only a quote has, on its order document. */
 export interface OrderQuote {
     stage: QuoteStage;
@@ -101,7 +218,12 @@ export interface OrderQuote {
     tax: QuoteTaxBasis;
     /** The customer approves the current revision's proof before they can pay. Absent reads as off. */
     requireProofApproval?: boolean;
-    proofs?: QuoteProofRef[];
+    /** The current revision's proofs; earlier revisions keep theirs in `revisions/{n}`. */
+    proofs?: QuoteProof[];
+    /** The customer's answers to the current revision, oldest first; the last one counts. */
+    responses?: QuoteCustomerResponse[];
+    /** The current revision's approval, while its latest answer is one. */
+    approval?: QuoteApproval | null;
     /** The revision the customer approved, when they have. */
     approvedRevision?: number | null;
     /**
@@ -110,6 +232,19 @@ export interface OrderQuote {
      * as 1. Bumped when the business replaces the link.
      */
     linkVersion?: number;
+    /** The conversation its emails keep in the customer's mailbox (AGL-4097). */
+    emailThread?: QuoteEmailThread | null;
+    /** Every time it was emailed to the customer, oldest first (AGL-4097). */
+    sends?: QuoteSendRecord[];
+    /**
+     * The request it was started from (AGL-4098): a "Request a quote" form's
+     * submission, by id. Its files are listed on the quote as the customer's
+     * ({@link requestFiles}), and its confirmation's conversation is the
+     * quote's {@link emailThread} until the quote is first sent.
+     */
+    request?: QuoteRequestRef | null;
+    /** The request's files, where the request keeps them; downloaded through the quote's own route. */
+    requestFiles?: QuoteResponseFile[];
     /** When the customer paid it. */
     paidAtMs?: number;
     /** Payments the quote could not take; see {@link QuoteUnmatchedPayment}. */
@@ -132,7 +267,9 @@ export declare function quoteRequiresProofApprovalByDefault(settings: QuoteStore
  * approval, its current revision has a proof, and that revision is not the
  * one the customer approved. A revision with no proof never holds a payment.
  */
-export declare function quotePaymentBlockedByApproval(quote: Pick<OrderQuote, 'requireProofApproval' | 'revision' | 'proofs' | 'approvedRevision'> | null | undefined): boolean;
+export declare function quotePaymentBlockedByApproval(quote: (Pick<OrderQuote, 'requireProofApproval' | 'revision' | 'approvedRevision'> & {
+    proofs?: readonly QuoteProofRef[];
+}) | null | undefined): boolean;
 /** Whether an order document is a quote, paid or not. */
 export declare function isQuote(order: Pick<Partial<HostOrder>, 'channel'> | null | undefined): boolean;
 /** Whether an order document is a quote nobody has paid yet, which no order list counts. */