shop-cli 0.1.1

package/dist/cli/verbs/returns.js

@@ -0,0 +1,506 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var returns_exports = {};
+__export(returns_exports, {
+  runReturns: () => runReturns
+});
+module.exports = __toCommonJS(returns_exports);
+var import_errors = require("../errors");
+var import_gid = require("../gid");
+var import_input = require("../input");
+var import_output = require("../output");
+var import_router = require("../router");
+var import_select = require("../selection/select");
+var import_userErrors = require("../userErrors");
+var import_shared = require("./_shared");
+const moneyV2Selection = { amount: true, currencyCode: true };
+const moneyBagSelection = {
+  shopMoney: moneyV2Selection,
+  presentmentMoney: moneyV2Selection
+};
+const returnSummarySelection = {
+  id: true,
+  name: true,
+  status: true,
+  createdAt: true,
+  order: { id: true, name: true },
+  totalQuantity: true,
+  returnLineItems: {
+    __args: { first: 20 },
+    nodes: {
+      __typename: true,
+      id: true,
+      quantity: true,
+      returnReason: true,
+      returnReasonNote: true,
+      on_ReturnLineItem: {
+        fulfillmentLineItem: {
+          lineItem: { id: true, title: true }
+        }
+      }
+    }
+  }
+};
+const returnFullSelection = {
+  ...returnSummarySelection,
+  decline: {
+    reason: true,
+    note: true
+  },
+  reverseFulfillmentOrders: {
+    __args: { first: 5 },
+    nodes: {
+      id: true,
+      status: true,
+      reverseDeliveries: {
+        __args: { first: 5 },
+        nodes: {
+          id: true,
+          deliverable: {
+            on_ReverseDeliveryShippingDeliverable: {
+              label: { id: true },
+              tracking: { number: true, url: true }
+            }
+          }
+        }
+      }
+    }
+  },
+  refunds: {
+    __args: { first: 5 },
+    nodes: {
+      id: true,
+      totalRefundedSet: moneyBagSelection
+    }
+  },
+  exchangeLineItems: {
+    __args: { first: 10 },
+    nodes: {
+      id: true,
+      lineItem: { id: true, title: true }
+    }
+  }
+};
+const refundSummarySelection = {
+  id: true,
+  createdAt: true,
+  totalRefundedSet: moneyBagSelection
+};
+const calculatedReturnSelection = {
+  id: true,
+  returnLineItems: {
+    id: true,
+    quantity: true,
+    subtotalSet: moneyBagSelection,
+    fulfillmentLineItem: {
+      id: true,
+      lineItem: { id: true, title: true }
+    }
+  },
+  exchangeLineItems: {
+    id: true,
+    quantity: true,
+    subtotalSet: moneyBagSelection
+  },
+  returnShippingFee: {
+    amountSet: moneyBagSelection
+  }
+};
+const returnReasonDefinitionSelection = {
+  id: true,
+  name: true,
+  handle: true
+};
+const returnableFulfillmentSelection = {
+  id: true,
+  fulfillment: { id: true, status: true },
+  returnableFulfillmentLineItems: {
+    __args: { first: 20 },
+    nodes: {
+      quantity: true,
+      fulfillmentLineItem: {
+        id: true,
+        lineItem: { id: true, title: true }
+      }
+    }
+  }
+};
+const getReturnSelection = (view) => {
+  if (view === "ids") return { id: true };
+  if (view === "full") return returnFullSelection;
+  if (view === "raw") return {};
+  return returnSummarySelection;
+};
+const requireOrderId = (value) => {
+  if (typeof value !== "string" || !value) throw new import_errors.CliError("Missing --order-id", 2);
+  return (0, import_gid.coerceGid)(value, "Order");
+};
+const requireReturnLineItemId = (value) => {
+  if (typeof value !== "string" || !value) throw new import_errors.CliError("Missing --return-line-item-id", 2);
+  return (0, import_gid.coerceGid)(value, "ReturnLineItem");
+};
+const parseQuantity = (value, flag) => {
+  if (value === void 0 || value === null || value === "") throw new import_errors.CliError(`Missing ${flag}`, 2);
+  const n = Number(value);
+  if (!Number.isFinite(n) || !Number.isInteger(n) || n <= 0) {
+    throw new import_errors.CliError(`${flag} must be a positive integer`, 2);
+  }
+  return n;
+};
+const runReturns = async ({
+  ctx,
+  verb,
+  argv
+}) => {
+  if (argv.includes("--help") || argv.includes("-h")) {
+    console.log(
+      [
+        "Usage:",
+        "  shop returns <verb> [flags]",
+        "",
+        "Verbs:",
+        "  create|get|calculate|cancel|close|reopen|process|refund|request|approve-request|decline-request",
+        "  remove-item|line-item-remove|reason-definitions|returnable-fulfillments",
+        "",
+        "State machine:",
+        "  REQUESTED \u2192 APPROVED \u2192 OPEN \u2192 IN_PROGRESS \u2192 CLOSED",
+        "      \u2193           \u2193        \u2193",
+        "   DECLINED    CANCELLED  CANCELLED",
+        "",
+        "Common output flags:",
+        "  --view summary|ids|full|raw",
+        "  --select <path>        (repeatable; dot paths; adds to base view selection)",
+        "  --selection <graphql>  (selection override; can be @file.gql)"
+      ].join("\n")
+    );
+    return;
+  }
+  if (verb === "get") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: {} });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const selection = (0, import_select.resolveSelection)({
+      resource: "returns",
+      view: ctx.view,
+      baseSelection: getReturnSelection(ctx.view),
+      select: args.select,
+      selection: args.selection,
+      include: args.include,
+      ensureId: ctx.quiet
+    });
+    const result = await (0, import_router.runQuery)(ctx, { return: { __args: { id }, ...selection } });
+    if (result === void 0) return;
+    (0, import_output.printNode)({ node: result.return, format: ctx.format, quiet: ctx.quiet });
+    return;
+  }
+  if (verb === "reason-definitions") {
+    const args = (0, import_router.parseStandardArgs)({
+      argv,
+      extraOptions: {
+        ids: { type: "string", multiple: true },
+        handles: { type: "string" }
+      }
+    });
+    const first = (0, import_shared.parseFirst)(args.first);
+    const after = args.after;
+    const query = args.query;
+    const reverse = args.reverse;
+    const ids = args.ids ? (0, import_shared.parseIds)(args.ids, "ReturnReasonDefinition") : void 0;
+    const handles = args.handles ? (0, import_shared.parseCsv)(args.handles, "--handles") : void 0;
+    const result = await (0, import_router.runQuery)(ctx, {
+      returnReasonDefinitions: {
+        __args: { first, after, query, reverse, ids, handles },
+        pageInfo: { hasNextPage: true, endCursor: true },
+        nodes: returnReasonDefinitionSelection
+      }
+    });
+    if (result === void 0) return;
+    (0, import_output.printConnection)({
+      connection: result.returnReasonDefinitions,
+      format: ctx.format,
+      quiet: ctx.quiet,
+      nextPageArgs: {
+        base: "shop returns reason-definitions",
+        first,
+        query,
+        reverse,
+        extraFlags: [
+          ...ids && ids.length > 0 ? [{ flag: "--ids", value: ids.join(",") }] : [],
+          ...handles && handles.length > 0 ? [{ flag: "--handles", value: handles.join(",") }] : []
+        ]
+      }
+    });
+    return;
+  }
+  if (verb === "returnable-fulfillments") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "order-id": { type: "string" } } });
+    const orderId = requireOrderId(args["order-id"]);
+    const first = (0, import_shared.parseFirst)(args.first);
+    const after = args.after;
+    const reverse = args.reverse;
+    const result = await (0, import_router.runQuery)(ctx, {
+      returnableFulfillments: {
+        __args: { first, after, reverse, orderId },
+        pageInfo: { hasNextPage: true, endCursor: true },
+        nodes: returnableFulfillmentSelection
+      }
+    });
+    if (result === void 0) return;
+    (0, import_output.printConnection)({
+      connection: result.returnableFulfillments,
+      format: ctx.format,
+      quiet: ctx.quiet,
+      nextPageArgs: {
+        base: "shop returns returnable-fulfillments",
+        first,
+        reverse,
+        extraFlags: [{ flag: "--order-id", value: orderId }]
+      }
+    });
+    return;
+  }
+  if (verb === "calculate") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "order-id": { type: "string" } } });
+    const built = (0, import_input.buildInput)({
+      inputArg: args.input,
+      setArgs: args.set,
+      setJsonArgs: args["set-json"]
+    });
+    if (!built.used) throw new import_errors.CliError("Missing --input or --set/--set-json", 2);
+    const orderId = args["order-id"] ? requireOrderId(args["order-id"]) : void 0;
+    const input = {
+      ...built.input,
+      ...orderId ? { orderId } : {}
+    };
+    if (!input.orderId) throw new import_errors.CliError("Missing --order-id (or input.orderId)", 2);
+    const result = await (0, import_router.runQuery)(ctx, {
+      returnCalculate: {
+        __args: { input },
+        ...calculatedReturnSelection
+      }
+    });
+    if (result === void 0) return;
+    (0, import_output.printNode)({ node: result.returnCalculate, format: ctx.format, quiet: ctx.quiet });
+    return;
+  }
+  if (verb === "create" || verb === "request") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "order-id": { type: "string" }, "notify-customer": { type: "boolean" } } });
+    const built = (0, import_input.buildInput)({
+      inputArg: args.input,
+      setArgs: args.set,
+      setJsonArgs: args["set-json"]
+    });
+    if (!built.used) throw new import_errors.CliError("Missing --input or --set/--set-json", 2);
+    const orderId = args["order-id"] ? requireOrderId(args["order-id"]) : void 0;
+    const input = {
+      ...built.input,
+      ...orderId ? { orderId } : {},
+      ...verb === "create" && args["notify-customer"] ? { notifyCustomer: true } : {}
+    };
+    if (!input.orderId) throw new import_errors.CliError("Missing --order-id (or input.orderId)", 2);
+    const mutationField = verb === "create" ? "returnCreate" : "returnRequest";
+    const mutationArgs = verb === "create" ? { returnInput: input } : { input };
+    const result = await (0, import_router.runMutation)(ctx, {
+      [mutationField]: {
+        __args: mutationArgs,
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    const payload = result[mutationField];
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(payload?.return?.id ?? "");
+    (0, import_output.printJson)(payload, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "approve-request") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "notify-customer": { type: "boolean" } } });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const result = await (0, import_router.runMutation)(ctx, {
+      returnApproveRequest: {
+        __args: { input: { id, ...args["notify-customer"] ? { notifyCustomer: true } : {} } },
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload: result.returnApproveRequest, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(result.returnApproveRequest?.return?.id ?? "");
+    (0, import_output.printJson)(result.returnApproveRequest, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "decline-request") {
+    const args = (0, import_router.parseStandardArgs)({
+      argv,
+      extraOptions: {
+        "decline-reason": { type: "string" },
+        "decline-note": { type: "string" },
+        "notify-customer": { type: "boolean" }
+      }
+    });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const declineReason = args["decline-reason"];
+    if (!declineReason) throw new import_errors.CliError("Missing --decline-reason", 2);
+    const input = { id, declineReason };
+    if (args["decline-note"]) input.declineNote = args["decline-note"];
+    if (args["notify-customer"]) input.notifyCustomer = true;
+    const result = await (0, import_router.runMutation)(ctx, {
+      returnDeclineRequest: {
+        __args: { input },
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload: result.returnDeclineRequest, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(result.returnDeclineRequest?.return?.id ?? "");
+    (0, import_output.printJson)(result.returnDeclineRequest, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "cancel" || verb === "close" || verb === "reopen") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "notify-customer": { type: "boolean" } } });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const mutationField = verb === "cancel" ? "returnCancel" : verb === "close" ? "returnClose" : "returnReopen";
+    const mutationArgs = verb === "cancel" && args["notify-customer"] ? { id, notifyCustomer: true } : { id };
+    const result = await (0, import_router.runMutation)(ctx, {
+      [mutationField]: {
+        __args: mutationArgs,
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    const payload = result[mutationField];
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(payload?.return?.id ?? "");
+    (0, import_output.printJson)(payload, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "process") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "notify-customer": { type: "boolean" } } });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const built = (0, import_input.buildInput)({
+      inputArg: args.input,
+      setArgs: args.set,
+      setJsonArgs: args["set-json"]
+    });
+    if (!built.used) throw new import_errors.CliError("Missing --input or --set/--set-json", 2);
+    const input = {
+      ...built.input,
+      returnId: id,
+      ...args["notify-customer"] ? { notifyCustomer: true } : {}
+    };
+    const result = await (0, import_router.runMutation)(ctx, {
+      returnProcess: {
+        __args: { input },
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload: result.returnProcess, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(result.returnProcess?.return?.id ?? "");
+    (0, import_output.printJson)(result.returnProcess, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "refund") {
+    const args = (0, import_router.parseStandardArgs)({ argv, extraOptions: { "notify-customer": { type: "boolean" } } });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const built = (0, import_input.buildInput)({
+      inputArg: args.input,
+      setArgs: args.set,
+      setJsonArgs: args["set-json"]
+    });
+    if (!built.used) throw new import_errors.CliError("Missing --input or --set/--set-json", 2);
+    const input = {
+      ...built.input,
+      returnId: id,
+      ...args["notify-customer"] ? { notifyCustomer: true } : {}
+    };
+    const result = await (0, import_router.runMutation)(ctx, {
+      returnRefund: {
+        __args: { returnRefundInput: input },
+        refund: refundSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload: result.returnRefund, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(result.returnRefund?.refund?.id ?? "");
+    (0, import_output.printJson)(result.returnRefund, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "remove-item") {
+    const args = (0, import_router.parseStandardArgs)({
+      argv,
+      extraOptions: { "return-line-item-id": { type: "string" }, quantity: { type: "string" } }
+    });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const returnLineItemId = requireReturnLineItemId(args["return-line-item-id"]);
+    const quantity = parseQuantity(args.quantity, "--quantity");
+    const result = await (0, import_router.runMutation)(ctx, {
+      removeFromReturn: {
+        __args: {
+          returnId: id,
+          returnLineItems: [{ returnLineItemId, quantity }]
+        },
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    (0, import_userErrors.maybeFailOnUserErrors)({ payload: result.removeFromReturn, failOnUserErrors: ctx.failOnUserErrors });
+    if (ctx.quiet) return console.log(result.removeFromReturn?.return?.id ?? "");
+    (0, import_output.printJson)(result.removeFromReturn, ctx.format !== "raw");
+    return;
+  }
+  if (verb === "line-item-remove") {
+    const args = (0, import_router.parseStandardArgs)({
+      argv,
+      extraOptions: { "return-line-item-id": { type: "string" }, quantity: { type: "string" } }
+    });
+    const id = (0, import_shared.requireId)(args.id, "Return");
+    const returnLineItemId = requireReturnLineItemId(args["return-line-item-id"]);
+    const quantity = parseQuantity(args.quantity, "--quantity");
+    const result = await (0, import_router.runMutation)(ctx, {
+      returnLineItemRemoveFromReturn: {
+        __args: {
+          returnId: id,
+          returnLineItems: [{ returnLineItemId, quantity }]
+        },
+        return: returnSummarySelection,
+        userErrors: { field: true, message: true }
+      }
+    });
+    if (result === void 0) return;
+    (0, import_userErrors.maybeFailOnUserErrors)({
+      payload: result.returnLineItemRemoveFromReturn,
+      failOnUserErrors: ctx.failOnUserErrors
+    });
+    if (ctx.quiet) return console.log(result.returnLineItemRemoveFromReturn?.return?.id ?? "");
+    (0, import_output.printJson)(result.returnLineItemRemoveFromReturn, ctx.format !== "raw");
+    return;
+  }
+  throw new import_errors.CliError(`Unknown verb for returns: ${verb}`, 2);
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  runReturns
+});
+//# sourceMappingURL=returns.js.map

package/dist/cli/verbs/reverse-deliveries.d.ts

@@ -0,0 +1,6 @@
+import { type CommandContext } from '../router';
+export declare const runReverseDeliveries: ({ ctx, verb, argv, }: {
+    ctx: CommandContext;
+    verb: string;
+    argv: string[];
+}) => Promise<void>;