@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/purchasing/purchase-orders.js

@@ -0,0 +1,491 @@
+import { pageFromVendureList, readOffsetCursor, } from '@sixtyninecommerce/core';
+export const PURCHASE_ORDER_LINE_FIELDS = /* GraphQL */ `
+  id
+  purchaseOrderId
+  position
+  productVariantId
+  supplierItemId
+  sku
+  name
+  supplierSku
+  purchaseUnitLabel
+  purchaseUnitFactor
+  orderedQuantity
+  orderedBaseQuantity
+  cancelledBaseQuantity
+  receivedBaseQuantity
+  returnedForReplacementBaseQuantity
+  unitPrice
+  discountBps
+  priceSource
+  vatRateBps
+  lineTotal
+  requestedOn
+  confirmedBaseQuantity
+  confirmedOn
+  confirmedAt
+  externalLineId
+  createdAt
+  updatedAt
+`;
+/**
+ * The header and lines, without the status history, which the engine reads per order: what the
+ * list selects, so a page stays one round of reads.
+ */
+export const PURCHASE_ORDER_SUMMARY_FIELDS = /* GraphQL */ `
+  id
+  scopeId
+  legalEntityId
+  originChannelId
+  code
+  kind
+  status
+  supplierId
+  supplier { id code name status }
+  destinationStockLocationId
+  destinationStockLocation { id name }
+  currencyCode
+  revision
+  approvedRevision
+  approvedAmount
+  requestedDeliveryOn
+  supplierReference
+  notesToSupplier
+  internalNotes
+  managedBy
+  externalId
+  externalNumber
+  externalApprovalStatus
+  sentAt
+  closedAt
+  closeReason
+  createdByRef
+  total
+  lineCount
+  confirmation
+  lines { ${PURCHASE_ORDER_LINE_FIELDS} }
+  createdAt
+  updatedAt
+`;
+/**
+ * A whole purchase order, its status history and revisions included: what `get` and every write
+ * answer.
+ */
+export const PURCHASE_ORDER_FIELDS = /* GraphQL */ `
+  ${PURCHASE_ORDER_SUMMARY_FIELDS}
+  statusHistory { id fromStatus status actorRef reason metadata createdAt }
+  revisions {
+    id
+    revision
+    state
+    diff
+    totalAfter
+    createdByRef
+    createdAt
+    appliedAt
+    sentAt
+    sentVia
+  }
+`;
+export const PURCHASE_ORDERS_QUERY = /* GraphQL */ `
+  query PurchaseOrders($options: PurchaseOrderListOptions) {
+    purchaseOrders(options: $options) {
+      totalItems
+      items { ${PURCHASE_ORDER_SUMMARY_FIELDS} }
+    }
+  }
+`;
+export const PURCHASE_ORDER_QUERY = /* GraphQL */ `
+  query PurchaseOrder($id: ID!) {
+    purchaseOrder(id: $id) { ${PURCHASE_ORDER_FIELDS} }
+  }
+`;
+export const CREATE_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation CreatePurchaseOrder($input: CreatePurchaseOrderInput!, $idempotencyKey: String) {
+    createPurchaseOrder(input: $input, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const UPDATE_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation UpdatePurchaseOrder($input: UpdatePurchaseOrderInput!, $idempotencyKey: String) {
+    updatePurchaseOrder(input: $input, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const ADD_PURCHASE_ORDER_LINES_MUTATION = /* GraphQL */ `
+  mutation AddPurchaseOrderLines(
+    $purchaseOrderId: ID!
+    $lines: [PurchaseOrderLineInput!]!
+    $idempotencyKey: String
+  ) {
+    addPurchaseOrderLines(
+      purchaseOrderId: $purchaseOrderId
+      lines: $lines
+      idempotencyKey: $idempotencyKey
+    ) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const UPDATE_PURCHASE_ORDER_LINE_MUTATION = /* GraphQL */ `
+  mutation UpdatePurchaseOrderLine(
+    $input: UpdatePurchaseOrderLineInput!
+    $idempotencyKey: String
+  ) {
+    updatePurchaseOrderLine(input: $input, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const REMOVE_PURCHASE_ORDER_LINE_MUTATION = /* GraphQL */ `
+  mutation RemovePurchaseOrderLine($id: ID!, $idempotencyKey: String) {
+    removePurchaseOrderLine(id: $id, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const SUBMIT_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation SubmitPurchaseOrder($id: ID!, $idempotencyKey: String) {
+    submitPurchaseOrder(id: $id, idempotencyKey: $idempotencyKey) { ${PURCHASE_ORDER_FIELDS} }
+  }
+`;
+export const APPROVE_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation ApprovePurchaseOrder($id: ID!, $idempotencyKey: String) {
+    approvePurchaseOrder(id: $id, idempotencyKey: $idempotencyKey) { ${PURCHASE_ORDER_FIELDS} }
+  }
+`;
+export const REJECT_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation RejectPurchaseOrder($id: ID!, $reason: String!, $idempotencyKey: String) {
+    rejectPurchaseOrder(id: $id, reason: $reason, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const CANCEL_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation CancelPurchaseOrder($id: ID!, $reason: String, $idempotencyKey: String) {
+    cancelPurchaseOrder(id: $id, reason: $reason, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+/**
+ * The cancel that states whether the supplier is emailed: sent only when `notifySupplier` is
+ * given, so a cancel without it still reaches an engine from before the cancellation email.
+ */
+export const CANCEL_PURCHASE_ORDER_NOTIFYING_MUTATION = /* GraphQL */ `
+  mutation CancelPurchaseOrderNotifying(
+    $id: ID!
+    $reason: String
+    $notifySupplier: Boolean
+    $idempotencyKey: String
+  ) {
+    cancelPurchaseOrder(
+      id: $id
+      reason: $reason
+      notifySupplier: $notifySupplier
+      idempotencyKey: $idempotencyKey
+    ) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const SEND_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation SendPurchaseOrder($id: ID!, $via: String!, $idempotencyKey: String) {
+    sendPurchaseOrder(id: $id, via: $via, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const REVISE_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation RevisePurchaseOrder($input: RevisePurchaseOrderInput!, $idempotencyKey: String) {
+    revisePurchaseOrder(input: $input, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const APPROVE_PURCHASE_ORDER_REVISION_MUTATION = /* GraphQL */ `
+  mutation ApprovePurchaseOrderRevision($purchaseOrderId: ID!, $idempotencyKey: String) {
+    approvePurchaseOrderRevision(
+      purchaseOrderId: $purchaseOrderId
+      idempotencyKey: $idempotencyKey
+    ) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const DISCARD_PURCHASE_ORDER_REVISION_MUTATION = /* GraphQL */ `
+  mutation DiscardPurchaseOrderRevision(
+    $purchaseOrderId: ID!
+    $reason: String
+    $idempotencyKey: String
+  ) {
+    discardPurchaseOrderRevision(
+      purchaseOrderId: $purchaseOrderId
+      reason: $reason
+      idempotencyKey: $idempotencyKey
+    ) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const CLOSE_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation ClosePurchaseOrder($id: ID!, $reason: String!, $idempotencyKey: String) {
+    closePurchaseOrder(id: $id, reason: $reason, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const REOPEN_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation ReopenPurchaseOrder($id: ID!, $reason: String, $idempotencyKey: String) {
+    reopenPurchaseOrder(id: $id, reason: $reason, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const CREATE_PURCHASE_ORDER_DOCUMENT_URL_MUTATION = /* GraphQL */ `
+  mutation CreatePurchaseOrderDocumentUrl($purchaseOrderId: ID!, $revision: Int) {
+    createPurchaseOrderDocumentUrl(purchaseOrderId: $purchaseOrderId, revision: $revision) {
+      url
+      expiresAt
+      filename
+      revision
+    }
+  }
+`;
+export const CONFIRM_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation ConfirmPurchaseOrder($input: ConfirmPurchaseOrderInput!, $idempotencyKey: String) {
+    confirmPurchaseOrder(input: $input, idempotencyKey: $idempotencyKey) {
+      ${PURCHASE_ORDER_FIELDS}
+    }
+  }
+`;
+export const DUPLICATE_PURCHASE_ORDER_MUTATION = /* GraphQL */ `
+  mutation DuplicatePurchaseOrder($id: ID!, $idempotencyKey: String) {
+    duplicatePurchaseOrder(id: $id, idempotencyKey: $idempotencyKey) { ${PURCHASE_ORDER_FIELDS} }
+  }
+`;
+export const IMPORT_PURCHASE_ORDER_LINES_MUTATION = /* GraphQL */ `
+  mutation ImportPurchaseOrderLines(
+    $input: ImportPurchaseOrderLinesInput!
+    $idempotencyKey: String
+  ) {
+    importPurchaseOrderLines(input: $input, idempotencyKey: $idempotencyKey) {
+      dryRun
+      contentHash
+      ignoredColumns
+      totalRows
+      created
+      updated
+      unchanged
+      failed
+      rows { row sku supplierSku outcome lineId errorCode message }
+      purchaseOrder { ${PURCHASE_ORDER_FIELDS} }
+    }
+  }
+`;
+/** The engine's own default page; it refuses a page above 100. */
+const DEFAULT_PAGE_SIZE = 50;
+const HEADER_INPUT_FIELDS = [
+    'requestedDeliveryOn',
+    'supplierReference',
+    'notesToSupplier',
+    'internalNotes',
+];
+const LINE_INPUT_FIELDS = [
+    'productVariantId',
+    'orderedQuantity',
+    'unitPrice',
+    'discountBps',
+    'requestedOn',
+];
+const LINE_PATCH_FIELDS = [
+    'orderedQuantity',
+    'unitPrice',
+    'discountBps',
+    'requestedOn',
+];
+const LIST_FILTERS = ['statuses', 'supplierId', 'destinationStockLocationId', 'term'];
+const CONFIRMATION_LINE_FIELDS = [
+    'lineId',
+    'confirmedBaseQuantity',
+    'confirmedOn',
+];
+const REVISION_HEADER_FIELDS = [
+    'destinationStockLocationId',
+    'requestedDeliveryOn',
+    'notesToSupplier',
+];
+/**
+ * Only the fields the engine's input declares, so a caller spreading what it read (which carries
+ * `id`, `lines`, `createdAt`, …) sends just the fields, and a field left out stays out. `null` is
+ * sent as `null` (cleared).
+ */
+function picked(input, fields) {
+    const out = {};
+    for (const field of fields) {
+        const value = input[field];
+        if (value !== undefined)
+            out[field] = value;
+    }
+    return out;
+}
+function linesOf(lines) {
+    return lines.map((line) => picked(line, LINE_INPUT_FIELDS));
+}
+export function createPurchasingPurchaseOrdersModule(transport) {
+    const listPage = async (skip, take, options) => {
+        const filters = options ? picked(options, LIST_FILTERS) : {};
+        const data = await transport.graphql({
+            api: 'admin',
+            query: PURCHASE_ORDERS_QUERY,
+            variables: { options: { skip, take, ...filters } },
+        }, options);
+        const items = data.purchaseOrders.items.map((order) => ({
+            ...order,
+            statusHistory: [],
+            revisions: [],
+        }));
+        return pageFromVendureList({ items, totalItems: data.purchaseOrders.totalItems }, skip, take, (cursor) => listPage(readOffsetCursor(cursor), take, options));
+    };
+    const mutate = async (field, query, variables, call) => {
+        const data = await transport.graphql({ api: 'admin', query, variables: { ...variables, idempotencyKey: call?.idempotencyKey } }, call);
+        return data[field];
+    };
+    return {
+        async list(options) {
+            const take = options?.limit ?? DEFAULT_PAGE_SIZE;
+            const skip = options?.after === undefined ? 0 : readOffsetCursor(options.after);
+            return listPage(skip, take, options);
+        },
+        async get(id, call) {
+            const data = await transport.graphql({ api: 'admin', query: PURCHASE_ORDER_QUERY, variables: { id } }, call);
+            return data.purchaseOrder;
+        },
+        create(input, call) {
+            const fields = {
+                ...picked(input, HEADER_INPUT_FIELDS),
+                supplierId: input.supplierId,
+            };
+            if (input.destinationStockLocationId !== undefined) {
+                fields.destinationStockLocationId = input.destinationStockLocationId;
+            }
+            if (input.currencyCode !== undefined)
+                fields.currencyCode = input.currencyCode;
+            if (input.lines !== undefined)
+                fields.lines = linesOf(input.lines);
+            return mutate('createPurchaseOrder', CREATE_PURCHASE_ORDER_MUTATION, { input: fields }, call);
+        },
+        update(id, input, call) {
+            const fields = { ...picked(input, HEADER_INPUT_FIELDS), id };
+            if (input.destinationStockLocationId !== undefined) {
+                fields.destinationStockLocationId = input.destinationStockLocationId;
+            }
+            return mutate('updatePurchaseOrder', UPDATE_PURCHASE_ORDER_MUTATION, { input: fields }, call);
+        },
+        lines: {
+            add(purchaseOrderId, lines, call) {
+                return mutate('addPurchaseOrderLines', ADD_PURCHASE_ORDER_LINES_MUTATION, { purchaseOrderId, lines: linesOf(lines) }, call);
+            },
+            update(lineId, input, call) {
+                return mutate('updatePurchaseOrderLine', UPDATE_PURCHASE_ORDER_LINE_MUTATION, { input: { ...picked(input, LINE_PATCH_FIELDS), id: lineId } }, call);
+            },
+            remove(lineId, call) {
+                return mutate('removePurchaseOrderLine', REMOVE_PURCHASE_ORDER_LINE_MUTATION, { id: lineId }, call);
+            },
+            async import(purchaseOrderId, content, options) {
+                const data = await transport.graphql({
+                    api: 'admin',
+                    query: IMPORT_PURCHASE_ORDER_LINES_MUTATION,
+                    variables: {
+                        input: {
+                            purchaseOrderId,
+                            content,
+                            ...(options?.dryRun === undefined ? {} : { dryRun: options.dryRun }),
+                        },
+                        idempotencyKey: options?.idempotencyKey,
+                    },
+                }, options);
+                return data.importPurchaseOrderLines;
+            },
+        },
+        submit(id, call) {
+            return mutate('submitPurchaseOrder', SUBMIT_PURCHASE_ORDER_MUTATION, { id }, call);
+        },
+        approve(id, call) {
+            return mutate('approvePurchaseOrder', APPROVE_PURCHASE_ORDER_MUTATION, { id }, call);
+        },
+        reject(id, reason, call) {
+            return mutate('rejectPurchaseOrder', REJECT_PURCHASE_ORDER_MUTATION, { id, reason }, call);
+        },
+        cancel(id, options) {
+            const notifying = options?.notifySupplier !== undefined;
+            return mutate('cancelPurchaseOrder', notifying ? CANCEL_PURCHASE_ORDER_NOTIFYING_MUTATION : CANCEL_PURCHASE_ORDER_MUTATION, {
+                id,
+                ...(options?.reason === undefined ? {} : { reason: options.reason }),
+                ...(notifying ? { notifySupplier: options?.notifySupplier } : {}),
+            }, options);
+        },
+        send(id, via, call) {
+            return mutate('sendPurchaseOrder', SEND_PURCHASE_ORDER_MUTATION, { id, via }, call);
+        },
+        revise(id, input, call) {
+            const fields = {
+                ...picked(input, REVISION_HEADER_FIELDS),
+                purchaseOrderId: id,
+            };
+            if (input.addLines !== undefined)
+                fields.addLines = linesOf(input.addLines);
+            if (input.updateLines !== undefined) {
+                fields.updateLines = input.updateLines.map((line) => ({
+                    ...picked(line, LINE_PATCH_FIELDS),
+                    id: line.id,
+                }));
+            }
+            if (input.removeLineIds !== undefined)
+                fields.removeLineIds = input.removeLineIds;
+            return mutate('revisePurchaseOrder', REVISE_PURCHASE_ORDER_MUTATION, { input: fields }, call);
+        },
+        revisions: {
+            approve(purchaseOrderId, call) {
+                return mutate('approvePurchaseOrderRevision', APPROVE_PURCHASE_ORDER_REVISION_MUTATION, { purchaseOrderId }, call);
+            },
+            discard(purchaseOrderId, options) {
+                return mutate('discardPurchaseOrderRevision', DISCARD_PURCHASE_ORDER_REVISION_MUTATION, {
+                    purchaseOrderId,
+                    ...(options?.reason === undefined ? {} : { reason: options.reason }),
+                }, options);
+            },
+        },
+        confirm(id, input, call) {
+            const fields = { purchaseOrderId: id };
+            if (input.supplierReference !== undefined)
+                fields.supplierReference = input.supplierReference;
+            if (input.lines !== undefined) {
+                fields.lines = input.lines.map((line) => picked(line, CONFIRMATION_LINE_FIELDS));
+            }
+            return mutate('confirmPurchaseOrder', CONFIRM_PURCHASE_ORDER_MUTATION, { input: fields }, call);
+        },
+        duplicate(id, call) {
+            return mutate('duplicatePurchaseOrder', DUPLICATE_PURCHASE_ORDER_MUTATION, { id }, call);
+        },
+        close(id, reason, call) {
+            return mutate('closePurchaseOrder', CLOSE_PURCHASE_ORDER_MUTATION, { id, reason }, call);
+        },
+        reopen(id, options) {
+            return mutate('reopenPurchaseOrder', REOPEN_PURCHASE_ORDER_MUTATION, { id, ...(options?.reason === undefined ? {} : { reason: options.reason }) }, options);
+        },
+        async document(id, options) {
+            const data = await transport.graphql({
+                api: 'admin',
+                query: CREATE_PURCHASE_ORDER_DOCUMENT_URL_MUTATION,
+                variables: {
+                    purchaseOrderId: id,
+                    ...(options?.revision === undefined ? {} : { revision: options.revision }),
+                },
+            }, options);
+            return data.createPurchaseOrderDocumentUrl;
+        },
+    };
+}