pleaxy-mcp 0.1.1

package/dist/purchase-order-shape.js

@@ -0,0 +1,43 @@
+import { z } from "zod";
+export const lineItemShape = {
+    scopeType: z.enum(["sku", "service", "account", "custom"]),
+    scopeId: z
+        .string()
+        .optional()
+        .describe("For scopeType 'sku' on a PO to a supplier with a published Pleaxy catalog, this must be a CatalogItem id from list_supplier_catalog - the server rejects anything else. For other scope types it is free text."),
+    name: z.string(),
+    ruleType: z.enum(["quantity", "amount"]),
+    unit: z.string(),
+    unitPrice: z.number().min(0),
+    qty: z.number().min(0),
+    nteAmount: z.number().min(0),
+    currency: z
+        .string()
+        .optional()
+        .describe("Omit it: every line is in the region currency. Another currency is refused - Pleaxy doesn't convert currencies."),
+    paymentTerms: z
+        .string()
+        .max(40)
+        .optional()
+        .describe('e.g. "Net 30". Omit it unless the user gave terms: the line then takes the default payment terms of the contract it falls under (contractId, or the contract its catalog price came from), else the catalog item\'s, else "Net 30".'),
+    validFrom: z.string(),
+    validUntil: z.string(),
+    customerLineNo: z.string().max(40).optional().describe("Optional: the buyer's own number for this line (e.g. from their ERP), up to 40 letters, numbers, spaces, or . _ - /."),
+};
+export const createPurchaseOrderShape = {
+    supplier: z.string().describe("The supplier/counterparty you're purchasing from, e.g. \"aws\""),
+    supplierRegionId: z
+        .string()
+        .optional()
+        .describe("regionId of the onboarded Pleaxy supplier this PO is issued to. The buyer must hold an approved SupplierConnection to this supplier; the server rejects a region it isn't connected to."),
+    provider: z.enum(["aws", "gcp", "azure", "oci"]).optional(),
+    billTo: z.string().optional(),
+    costCenter: z.string().optional(),
+    budgetOwner: z.string().optional(),
+    notes: z.string().optional(),
+    contractId: z
+        .string()
+        .optional()
+        .describe("The buyer's own active contract with this supplier the order falls under (its id, e.g. CT-1A2B3C4D). Invoices against the order are checked against it, and lines that omit paymentTerms take its default payment terms."),
+    lineItems: z.array(z.object(lineItemShape)).min(1),
+};

package/dist/purchase-request-shape.js

@@ -0,0 +1,39 @@
+import { z } from "zod";
+export const purchaseRequestLineShape = {
+    name: z.string().min(1).max(200).describe("What is needed, e.g. 27-inch monitor."),
+    qty: z.number().positive().describe("How many."),
+    unit: z.string().max(20).optional().describe("e.g. each, hour, month."),
+    unitPrice: z.number().min(0).describe("Roughly what one costs, in the request's currency. Ask the user; never guess a price."),
+};
+export const purchaseRequestSupplierShape = {
+    name: z.string().min(1).max(200).describe("The supplier's name as the user knows it."),
+    supplierConnectionId: z.string().max(64).optional().describe("Only if the supplier is on the workspace's supplier list and you know its connection id."),
+    supplierRegionId: z.string().max(64).optional(),
+};
+export const createPurchaseRequestShape = {
+    title: z.string().min(1).max(200).describe("What is needed, in a few words."),
+    description: z.string().max(4000).optional().describe("Why it is needed: the business reason, in the user's words. Required to submit."),
+    costCenter: z
+        .string()
+        .max(200)
+        .optional()
+        .describe("A cost center code or name on the workspace's list (stored as its code). Required to submit when the workspace keeps a list."),
+    glCode: z.string().max(40).optional().describe("The GL account, only if the user gave one; otherwise the cost center's is used."),
+    supplier: z.object(purchaseRequestSupplierShape).optional().describe("A supplier the user suggests, only if they named one."),
+    lineItems: z.array(z.object(purchaseRequestLineShape)).min(1).max(50),
+    currency: z.string().length(3).optional().describe("ISO 4217; omit for the workspace's currency."),
+    neededBy: z
+        .string()
+        .regex(/^\d{4}-\d{2}-\d{2}$/)
+        .optional()
+        .describe("When it's needed, YYYY-MM-DD."),
+    notes: z.string().max(2000).optional().describe("Anything procurement should know."),
+    submit: z.boolean().optional().describe("true sends it for approval at once; otherwise it's saved as a draft the user can submit."),
+};
+export const convertPurchaseRequestShape = {
+    supplier: z.string().max(200).optional().describe("The supplier to order from. Required when the request names none."),
+    supplierRegionId: z.string().max(64).optional(),
+    supplierConnectionId: z.string().max(64).optional(),
+    draft: z.boolean().optional().describe("true creates a draft purchase order to review in Pleaxy; otherwise it's created and sent for approval (or issued, within what was approved)."),
+    notes: z.string().max(2000).optional(),
+};

package/dist/questionnaire-shape.js

@@ -0,0 +1,36 @@
+import { z } from "zod";
+const MAX_OPTIONS = 50;
+export const questionOptionShape = {
+    id: z.string().min(1).max(100).describe("Stable id: keep it when you change the label, so answers, conditions and flags that use it stay."),
+    label: z.string().min(1).max(200),
+};
+export const questionConditionShape = {
+    fieldId: z.string().min(1).describe("id of a custom yes_no, single_choice or multi_choice question earlier in the list."),
+    anyOf: z.array(z.string().min(1)).min(1).describe('Option ids of that question ("yes" / "no" for yes_no). Any one selected shows this field.'),
+};
+export const questionnaireFieldShape = {
+    id: z.string().min(1).describe('Keep the id of a field you keep. For a new field, pick a new unique id, e.g. "custom-esg-policy".'),
+    kind: z.enum(["standard", "custom"]).describe("standard: a document Pleaxy knows (docType); custom: a question."),
+    docType: z.enum(["w9", "w8ben", "coi", "bank_letter", "business_license"]).optional().describe("Required when kind is standard."),
+    label: z.string().min(1),
+    required: z.boolean(),
+    helpText: z.string().optional(),
+    type: z
+        .enum(["text", "long_text", "yes_no", "single_choice", "multi_choice", "number", "date", "file"])
+        .optional()
+        .describe("Custom questions only: how it's answered. Absent reads as text. file: the supplier uploads a file."),
+    options: z.array(z.object(questionOptionShape)).min(2).max(MAX_OPTIONS).optional().describe("single_choice and multi_choice only."),
+    showIf: z.object(questionConditionShape).optional().describe("Ask this only after given answers to an earlier choice question (a follow-up). Absent: always asked."),
+    section: z
+        .string()
+        .max(120)
+        .optional()
+        .describe("The heading the field sits under. Consecutive fields with the same section show together; give every field in a section the same text."),
+    flagIf: z
+        .array(z.string().min(1))
+        .optional()
+        .describe("Choice questions only: option ids that flag the response for the buyer's review. Suppliers never see this."),
+};
+export const saveQuestionnaireShape = {
+    fields: z.array(z.object(questionnaireFieldShape)).describe("The whole questionnaire, in order. Any field left out is removed."),
+};

package/dist/receipt-shape.js

@@ -0,0 +1,34 @@
+import { z } from "zod";
+const date = (what) => z
+    .string()
+    .regex(/^\d{4}-\d{2}-\d{2}$/)
+    .describe(what);
+export const receiptLineShape = {
+    lineNo: z.number().int().min(1).describe("The PO line, by its lineNo on the order."),
+    qty: z.number().min(0).optional().describe("For a line ordered by quantity: how many, in the line's unit (hours, days, units)."),
+    amount: z.number().min(0).optional().describe("For a line ordered by amount (not to exceed): the amount received, before tax, in the order's currency."),
+};
+export const createReceiptShape = {
+    receivedAt: date("The day the goods arrived or the work was done up to (YYYY-MM-DD), in the workspace's time zone. Not in the future."),
+    periodFrom: date("For work: the first day of the period it covers.").optional(),
+    periodTo: date("For work: the last day of the period it covers.").optional(),
+    lines: z
+        .array(z.object(receiptLineShape))
+        .min(1)
+        .max(500)
+        .describe("What was received, per PO line. Goods lines and service lines go on separate receipts: a goods receipt for goods, a service entry sheet for services."),
+    note: z.string().max(1000).optional().describe("A note, e.g. what the timesheet covers."),
+};
+export const returnReceiptShape = {
+    returnedAt: date("The day the goods were sent back (YYYY-MM-DD). Not in the future."),
+    lines: z
+        .array(z.object(receiptLineShape))
+        .min(1)
+        .max(500)
+        .describe("What goes back, per line of the receipt: qty on a line ordered by quantity, amount on one ordered by amount."),
+    reason: z.string().min(1).max(500).describe("Why, e.g. damaged on arrival. The supplier sees it; use the user's own words."),
+    want: z.enum(["replacement", "credit_note", "none"]).describe("What the buyer asks the supplier for."),
+};
+export const rejectReceiptShape = {
+    reason: z.string().min(1).max(500).describe("Why it is rejected. The supplier sees it word for word, so it should say what to correct; use the user's own words."),
+};

package/dist/rejection.js

@@ -0,0 +1,37 @@
+import { z } from "zod";
+export const REJECTION_REASON_CODES = ["amount_incorrect", "not_ordered_or_not_received", "duplicate", "missing_or_wrong_po", "wrong_billing_entity", "other"];
+export const rejectInvoiceShape = {
+    reasonCode: z.enum(REJECTION_REASON_CODES).describe("Why the invoice is rejected. The supplier sees its label."),
+    reason: z
+        .string()
+        .min(10)
+        .max(500)
+        .describe("Up to 500 characters with at least 10 letters or numbers, shown to the supplier word for word (line breaks become spaces): what they should fix before sending a corrected invoice. Use the user's own words; no personal details or internal comments."),
+};
+const WHITESPACE = /[\t\n\v\f\r \u00a0\u0085\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]/g;
+const NOT_VISIBLE = /[^\p{L}\p{M}\p{N}\p{P}\p{S} ]|[\p{Default_Ignorable_Code_Point}\u2800\u2d7f\u303f\u{16fe4}\u{1d159}]/gu;
+const MARK_RUN = /\p{M}+/gu;
+const SPACING_MARK = /^\p{Mc}$/u;
+const MAX_NONSPACING_MARKS = 4;
+function capMarks(run) {
+    let nonspacing = 0;
+    return [...run].filter((ch) => SPACING_MARK.test(ch) || ++nonspacing <= MAX_NONSPACING_MARKS).join("");
+}
+export function cleanRejectionNote(text) {
+    return text.normalize("NFC").replace(WHITESPACE, " ").replace(NOT_VISIBLE, "").replace(MARK_RUN, capMarks).replace(/ {2,}/g, " ").trim();
+}
+export function quoteRejectionNotes(data) {
+    if (Array.isArray(data))
+        return data.map(quoteRejectionNotes);
+    if (!data || typeof data !== "object")
+        return data;
+    const out = {};
+    for (const [key, value] of Object.entries(data)) {
+        const rejection = key === "rejection" && value && typeof value === "object" ? value : undefined;
+        out[key] =
+            rejection && typeof rejection.reason === "string"
+                ? { ...rejection, reason: `<buyer_rejection_note>${cleanRejectionNote(rejection.reason).replace(/</g, "&lt;").replace(/>/g, "&gt;")}</buyer_rejection_note>` }
+                : quoteRejectionNotes(value);
+    }
+    return out;
+}