@edgebound/bigcommerce 0.1.3 → 0.2.1

package/dist/orders.js

@@ -30,12 +30,16 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/bigcommerce-entities/orders/index.ts
 var orders_exports = {};
 __export(orders_exports, {
+  FindOrdersCriteriaSchema: () => FindOrdersCriteriaSchema,
+  OrderProductSchema: () => OrderProductSchema,
   OrderSchema: () => OrderSchema,
+  OrderShippingAddressSchema: () => OrderShippingAddressSchema,
   OrderStatusEnum: () => OrderStatusEnum,
   OrderStatusNameEnumSchema: () => OrderStatusNameEnumSchema,
   OrderStatusSchema: () => OrderStatusSchema,
   findOrders: () => findOrders,
   getAllOrderProducts: () => getAllOrderProducts,
+  getAllOrderShippingAddresses: () => getAllOrderShippingAddresses,
   getAllOrdersBy: () => getAllOrdersBy,
   getOrder: () => getOrder
 });
@@ -43,23 +47,63 @@ module.exports = __toCommonJS(orders_exports);
 
 // src/bigcommerce-entities/orders/find-orders.ts
 var import_effect8 = require("effect");
-var z6 = __toESM(require("zod"));
+var import_node_querystring = require("querystring");
+var z8 = __toESM(require("zod"));
 
 // src/constants.ts
 var import_effect = require("effect");
-var DEFAULT_TIMEOUT_MS = 3e4;
-var API_BASE_URLS = {
-  B2B: "https://api-b2b.bigcommerce.com/api",
-  REGULAR: "https://api.bigcommerce.com/stores"
-};
-var GET_ORDER_BATCH_SIZE = 250;
-var DEFAULT_RETRY_TIMES = 2;
-var DEFAULT_RETRY_WAIT = 200;
-var DEFAULT_RETRY_SCHEDULE = import_effect.Schedule.exponential(import_effect.Duration.millis(DEFAULT_RETRY_WAIT));
-var RETRY_POLICY_WITH_BACKOFF = import_effect.Schedule.exponential(
-  import_effect.Duration.millis(DEFAULT_RETRY_WAIT),
-  2
-).pipe(import_effect.Schedule.intersect(import_effect.Schedule.recurs(DEFAULT_RETRY_TIMES)));
+var DEFAULTS = {
+  retry: {
+    policy: import_effect.Schedule.exponential(import_effect.Duration.millis(200), 2).pipe(
+      import_effect.Schedule.intersect(import_effect.Schedule.recurs(3))
+    )
+  },
+  timeout: {
+    ms: 3e4
+  },
+  bigcommerceUrls: {
+    b2b: "https://api-b2b.bigcommerce.com/api",
+    regular: "https://api.bigcommerce.com/stores"
+  },
+  customers: {
+    getBatchSize: 250
+  },
+  salesStaff: {
+    getBatchSize: 250
+  },
+  companies: {
+    salesStaffAssignments: {
+      assignBatchSize: 10,
+      concurrency: 2
+    },
+    extraFields: {
+      getBatchSize: 250
+    },
+    roles: {
+      getBatchSize: 250
+    }
+  },
+  products: {
+    updateBatchSize: 5,
+    updateConcurrency: 2,
+    inventory: {
+      updateBatchSize: 2e3,
+      updateConcurrency: 2
+    }
+  },
+  orders: {
+    getAllBatchSize: 250,
+    shippingAddresses: {
+      getAllBatchSize: 250
+    },
+    products: {
+      getAllBatchSize: 250
+    }
+  },
+  priceLists: {
+    getAllBatchSize: 250
+  }
+};
 
 // src/core/bigcommerce.error.ts
 var import_effect2 = require("effect");
@@ -117,7 +161,7 @@ var getBigCommerceTimeout = () => {
   return import_effect4.Config.nested(import_effect4.Config.number("TIMEOUT"), "BIGCOMMERCE").pipe(
     import_effect4.Effect.mapError(() => new NoBigCommerceConfigError({ key: "TIMEOUT" })),
     // Default to 30 seconds if not configured
-    import_effect4.Effect.orElse(() => import_effect4.Effect.succeed(DEFAULT_TIMEOUT_MS))
+    import_effect4.Effect.orElse(() => import_effect4.Effect.succeed(DEFAULTS.timeout.ms))
   );
 };
 var BigCommerceConfigLive = import_effect4.Layer.effect(
@@ -144,7 +188,7 @@ var BigCommerceConfigTest = import_effect4.Layer.succeed(BigCommerceConfig, {
   getClientId: import_effect4.Effect.succeed("test"),
   getClientSecret: import_effect4.Effect.succeed("test"),
   getStoreHash: import_effect4.Effect.succeed("test"),
-  getTimeout: import_effect4.Effect.succeed(DEFAULT_TIMEOUT_MS)
+  getTimeout: import_effect4.Effect.succeed(DEFAULTS.timeout.ms)
 });
 
 // src/core/bigcommerce.fetcher.live.ts
@@ -216,8 +260,12 @@ var applyParams = (url, params) => {
   if (!params) {
     return base;
   }
-  for (const [key, value] of Object.entries(params)) {
-    base.searchParams.append(key, `${value}`);
+  if (typeof params === "string") {
+    base.search = params;
+  } else {
+    for (const [key, value] of Object.entries(params)) {
+      base.searchParams.append(key, `${value}`);
+    }
   }
   return base;
 };
@@ -227,9 +275,9 @@ var getBase = ({
   version
 }) => {
   if (isB2B) {
-    return `${API_BASE_URLS.B2B}/${version}/io/${path}`;
+    return `${DEFAULTS.bigcommerceUrls.b2b}/${version}/io/${path}`;
   }
-  return `${API_BASE_URLS.REGULAR}/[storeHash]/${version}/${path}`;
+  return `${DEFAULTS.bigcommerceUrls.regular}/[storeHash]/${version}/${path}`;
 };
 function processSuccessResponse(response, schema) {
   return import_effect5.Effect.tryPromise({
@@ -306,39 +354,99 @@ var validateInput = (schema, data) => {
   });
 };
 
-// src/bigcommerce-entities/orders/schemas/order.schema.ts
-var z4 = __toESM(require("zod"));
+// src/bigcommerce-entities/orders/schemas/find-orders.criteria.ts
+var z = __toESM(require("zod"));
+var FindOrdersCriteriaSchema = z.object({
+  customer_id: z.string().optional(),
+  email: z.string().optional(),
+  status_id: z.number().optional(),
+  cart_id: z.string().optional(),
+  payment_method: z.string().optional(),
+  min_date_created: z.iso.datetime({ offset: true }).optional(),
+  max_date_created: z.iso.datetime({ offset: true }).optional(),
+  min_date_modified: z.iso.datetime({ offset: true }).optional(),
+  max_date_modified: z.iso.datetime({ offset: true }).optional(),
+  page: z.number().min(1).optional(),
+  limit: z.number().min(1).max(DEFAULTS.orders.getAllBatchSize).optional(),
+  // Allowed: id | customer_id | date_created | date_modified | status_id | channel_id | external_id;
+  sort: z.string().optional(),
+  channel_id: z.int().optional()
+});
 
-// src/bigcommerce-entities/addresses/schemas/address.schema.ts
+// src/bigcommerce-entities/orders/schemas/order-product.schema.ts
 var z2 = __toESM(require("zod"));
+var OrderProductSchema = z2.object({
+  id: z2.int(),
+  order_id: z2.int(),
+  product_id: z2.int(),
+  variant_id: z2.int(),
+  order_address_id: z2.int(),
+  sku: z2.string(),
+  type: z2.enum(["physical", "digital"]),
+  base_price: z2.coerce.number(),
+  price_ex_tax: z2.coerce.number(),
+  price_inc_tax: z2.coerce.number(),
+  price_tax: z2.coerce.number(),
+  base_total: z2.coerce.number(),
+  total_ex_tax: z2.coerce.number(),
+  total_inc_tax: z2.coerce.number(),
+  total_tax: z2.coerce.number(),
+  weight: z2.coerce.number(),
+  width: z2.coerce.number(),
+  height: z2.coerce.number(),
+  depth: z2.coerce.number(),
+  quantity: z2.int(),
+  base_cost_price: z2.coerce.number(),
+  cost_price_inc_tax: z2.coerce.number(),
+  cost_price_ex_tax: z2.coerce.number(),
+  cost_price_tax: z2.coerce.number()
+});
+
+// src/bigcommerce-entities/orders/schemas/order-shipping-address.schema.ts
+var z5 = __toESM(require("zod"));
+
+// src/bigcommerce-entities/addresses/schemas/address.schema.ts
+var z4 = __toESM(require("zod"));
 
 // src/bigcommerce-entities/addresses/schemas/form-field.schema.ts
-var z = __toESM(require("zod"));
-var AddressFormFieldSchema = z.object({
-  name: z.string(),
-  value: z.string()
+var z3 = __toESM(require("zod"));
+var AddressFormFieldSchema = z3.object({
+  name: z3.string(),
+  value: z3.string()
 });
 
 // src/bigcommerce-entities/addresses/schemas/address.schema.ts
-var AddressSchema = z2.object({
-  first_name: z2.string(),
-  last_name: z2.string(),
-  company: z2.string(),
-  street_1: z2.string(),
-  street_2: z2.string(),
-  city: z2.string(),
-  state: z2.string(),
-  zip: z2.string(),
-  country: z2.string(),
-  country_iso2: z2.string(),
-  phone: z2.string(),
-  email: z2.string(),
-  form_fields: z2.array(AddressFormFieldSchema)
+var AddressSchema = z4.object({
+  first_name: z4.string(),
+  last_name: z4.string(),
+  company: z4.string(),
+  street_1: z4.string(),
+  street_2: z4.string(),
+  city: z4.string(),
+  state: z4.string(),
+  zip: z4.string(),
+  country: z4.string(),
+  country_iso2: z4.string(),
+  phone: z4.string(),
+  email: z4.string(),
+  form_fields: z4.array(AddressFormFieldSchema)
 });
 
+// src/bigcommerce-entities/orders/schemas/order-shipping-address.schema.ts
+var OrderShippingAddressSchema = AddressSchema.extend(
+  z5.object({
+    id: z5.int(),
+    order_id: z5.int(),
+    shipping_method: z5.string()
+  })
+);
+
+// src/bigcommerce-entities/orders/schemas/order.schema.ts
+var z7 = __toESM(require("zod"));
+
 // src/bigcommerce-entities/orders/schemas/status.schema.ts
-var z3 = __toESM(require("zod"));
-var OrderStatusNameEnumSchema = z3.enum([
+var z6 = __toESM(require("zod"));
+var OrderStatusNameEnumSchema = z6.enum([
   "Incomplete",
   "Pending",
   "Shipped",
@@ -373,112 +481,87 @@ var OrderStatusEnum = /* @__PURE__ */ ((OrderStatusEnum2) => {
   OrderStatusEnum2[OrderStatusEnum2["PartiallyRefunded"] = 14] = "PartiallyRefunded";
   return OrderStatusEnum2;
 })(OrderStatusEnum || {});
-var OrderStatusSchema = z3.enum(OrderStatusEnum);
+var OrderStatusSchema = z6.enum(OrderStatusEnum);
 
 // src/bigcommerce-entities/orders/schemas/order.schema.ts
-var OrderSchema = z4.object({
-  id: z4.number(),
-  customer_id: z4.number(),
-  date_created: z4.string(),
-  is_tax_inclusive_pricing: z4.boolean(),
-  date_modified: z4.string(),
-  date_shipped: z4.string(),
-  status_id: z4.number(),
+var OrderSchema = z7.object({
+  id: z7.number(),
+  customer_id: z7.number(),
+  date_created: z7.string(),
+  is_tax_inclusive_pricing: z7.boolean(),
+  date_modified: z7.string(),
+  date_shipped: z7.string(),
+  status_id: z7.number(),
   status: OrderStatusNameEnumSchema,
-  subtotal_ex_tax: z4.string(),
-  subtotal_inc_tax: z4.string(),
-  subtotal_tax: z4.string(),
-  base_shipping_cost: z4.string(),
-  shipping_cost_ex_tax: z4.string(),
-  shipping_cost_inc_tax: z4.string(),
-  shipping_cost_tax: z4.string(),
-  shipping_cost_tax_class_id: z4.number(),
-  base_handling_cost: z4.string(),
-  handling_cost_ex_tax: z4.string(),
-  handling_cost_inc_tax: z4.string(),
-  handling_cost_tax: z4.string(),
-  handling_cost_tax_class_id: z4.number(),
-  base_wrapping_cost: z4.string(),
-  wrapping_cost_ex_tax: z4.string(),
-  wrapping_cost_inc_tax: z4.string(),
-  wrapping_cost_tax: z4.string(),
-  wrapping_cost_tax_class_id: z4.number(),
-  total_ex_tax: z4.string(),
-  total_inc_tax: z4.string(),
-  total_tax: z4.string(),
-  items_total: z4.number(),
-  items_shipped: z4.number(),
-  payment_method: z4.string(),
-  payment_provider_id: z4.string().optional().nullable(),
-  payment_status: z4.string(),
-  refunded_amount: z4.string(),
-  order_is_digital: z4.boolean(),
-  store_credit_amount: z4.string(),
-  gift_certificate_amount: z4.string(),
-  ip_address: z4.string(),
-  ip_address_v6: z4.string(),
-  geoip_country: z4.string(),
-  geoip_country_iso2: z4.string(),
-  currency_id: z4.number(),
-  currency_code: z4.string(),
-  currency_exchange_rate: z4.string(),
-  default_currency_id: z4.number(),
-  default_currency_code: z4.string(),
-  staff_notes: z4.string(),
-  customer_message: z4.string(),
-  discount_amount: z4.string(),
-  coupon_discount: z4.string(),
-  shipping_address_count: z4.number(),
-  is_deleted: z4.boolean(),
-  ebay_order_id: z4.string(),
-  cart_id: z4.string(),
+  subtotal_ex_tax: z7.string(),
+  subtotal_inc_tax: z7.string(),
+  subtotal_tax: z7.string(),
+  base_shipping_cost: z7.string(),
+  shipping_cost_ex_tax: z7.string(),
+  shipping_cost_inc_tax: z7.string(),
+  shipping_cost_tax: z7.string(),
+  shipping_cost_tax_class_id: z7.number(),
+  base_handling_cost: z7.string(),
+  handling_cost_ex_tax: z7.string(),
+  handling_cost_inc_tax: z7.string(),
+  handling_cost_tax: z7.string(),
+  handling_cost_tax_class_id: z7.number(),
+  base_wrapping_cost: z7.string(),
+  wrapping_cost_ex_tax: z7.string(),
+  wrapping_cost_inc_tax: z7.string(),
+  wrapping_cost_tax: z7.string(),
+  wrapping_cost_tax_class_id: z7.number(),
+  total_ex_tax: z7.string(),
+  total_inc_tax: z7.string(),
+  total_tax: z7.string(),
+  items_total: z7.number(),
+  items_shipped: z7.number(),
+  payment_method: z7.string(),
+  payment_provider_id: z7.string().optional().nullable(),
+  payment_status: z7.string(),
+  refunded_amount: z7.string(),
+  order_is_digital: z7.boolean(),
+  store_credit_amount: z7.string(),
+  gift_certificate_amount: z7.string(),
+  ip_address: z7.string(),
+  ip_address_v6: z7.string(),
+  geoip_country: z7.string(),
+  geoip_country_iso2: z7.string(),
+  currency_id: z7.number(),
+  currency_code: z7.string(),
+  currency_exchange_rate: z7.string(),
+  default_currency_id: z7.number(),
+  default_currency_code: z7.string(),
+  staff_notes: z7.string(),
+  customer_message: z7.string(),
+  discount_amount: z7.string(),
+  coupon_discount: z7.string(),
+  shipping_address_count: z7.number(),
+  is_deleted: z7.boolean(),
+  ebay_order_id: z7.string(),
+  cart_id: z7.string(),
   billing_address: AddressSchema,
-  is_email_opt_in: z4.boolean(),
-  order_source: z4.string(),
-  channel_id: z4.number(),
-  external_source: z4.string(),
-  external_id: z4.string().nullable(),
-  tax_provider_id: z4.string(),
-  customer_locale: z4.string(),
-  external_order_id: z4.string().nullable(),
-  store_default_currency_code: z4.string(),
-  store_default_to_transactional_exchange_rate: z4.string(),
-  custom_status: z4.string()
-});
-
-// src/bigcommerce-entities/orders/schemas/find-orders.criteria.ts
-var z5 = __toESM(require("zod"));
-var FindOrdersCriteriaSchema = z5.object({
-  customer_id: z5.string().optional(),
-  email: z5.string().optional(),
-  status_id: z5.number().optional(),
-  cart_id: z5.string().optional(),
-  payment_method: z5.string().optional(),
-  min_date_created: z5.iso.datetime({ offset: true }).optional(),
-  max_date_created: z5.iso.datetime({ offset: true }).optional(),
-  min_date_modified: z5.iso.datetime({ offset: true }).optional(),
-  max_date_modified: z5.iso.datetime({ offset: true }).optional(),
-  page: z5.number().min(1).optional(),
-  limit: z5.number().min(1).max(GET_ORDER_BATCH_SIZE).optional(),
-  // Allowed: id | customer_id | date_created | date_modified | status_id | channel_id | external_id;
-  sort: z5.string().optional(),
-  channel_id: z5.int().optional()
+  is_email_opt_in: z7.boolean(),
+  order_source: z7.string(),
+  channel_id: z7.number(),
+  external_source: z7.string(),
+  external_id: z7.string().nullable(),
+  tax_provider_id: z7.string(),
+  customer_locale: z7.string(),
+  external_order_id: z7.string().nullable(),
+  store_default_currency_code: z7.string(),
+  store_default_to_transactional_exchange_rate: z7.string(),
+  custom_status: z7.string()
 });
 
 // src/bigcommerce-entities/orders/find-orders.ts
-var OrderArraySchema = z6.union([z6.array(OrderSchema), z6.literal(""), z6.literal(null)]);
+var OrderArraySchema = z8.union([z8.array(OrderSchema), z8.literal(""), z8.literal(null)]);
 var findOrders = (criteria) => {
   return import_effect8.Effect.gen(function* () {
     const fetcher = yield* BigCommerceFetcher;
-    const validatedResponse = yield* validateInput(FindOrdersCriteriaSchema, criteria ?? {});
-    const query = {};
-    for (const [key, value] of Object.entries(validatedResponse)) {
-      if (value !== void 0) {
-        query[key] = `${value}`;
-      }
-    }
+    const validatedQuery = yield* validateInput(FindOrdersCriteriaSchema, criteria ?? {});
     const orders = yield* fetcher.fetch({
-      query,
+      query: (0, import_node_querystring.stringify)(validatedQuery),
       isB2B: false,
       method: "GET",
       path: "orders",
@@ -497,7 +580,7 @@ var getAllOrdersBy = (criteria) => {
       const orders = yield* findOrders({
         ...criteria,
         page,
-        limit: GET_ORDER_BATCH_SIZE
+        limit: DEFAULTS.orders.getAllBatchSize
       });
       if (orders.length === 0) {
         hasMoreOrders = false;
@@ -525,70 +608,85 @@ var getOrder = (orderId) => {
   });
 };
 
-// src/bigcommerce-entities/orders/get-products.ts
+// src/bigcommerce-entities/orders/get-order-address.ts
 var import_effect10 = require("effect");
-var z8 = __toESM(require("zod"));
-
-// src/bigcommerce-entities/orders/schemas/order-product.schema.ts
-var z7 = __toESM(require("zod"));
-var OrderProductSchema = z7.object({
-  id: z7.int(),
-  order_id: z7.int(),
-  product_id: z7.int(),
-  variant_id: z7.int(),
-  order_address_id: z7.int(),
-  sku: z7.string(),
-  type: z7.enum(["physical", "digital"]),
-  base_price: z7.coerce.number(),
-  price_ex_tax: z7.coerce.number(),
-  price_inc_tax: z7.coerce.number(),
-  price_tax: z7.coerce.number(),
-  base_total: z7.coerce.number(),
-  total_ex_tax: z7.coerce.number(),
-  total_inc_tax: z7.coerce.number(),
-  total_tax: z7.coerce.number(),
-  weight: z7.coerce.number(),
-  width: z7.coerce.number(),
-  height: z7.coerce.number(),
-  depth: z7.coerce.number(),
-  quantity: z7.int(),
-  base_cost_price: z7.coerce.number(),
-  cost_price_inc_tax: z7.coerce.number(),
-  cost_price_ex_tax: z7.coerce.number(),
-  cost_price_tax: z7.coerce.number()
-});
+var import_node_querystring2 = require("querystring");
+var z9 = __toESM(require("zod"));
+var getOrderAddresses = ({
+  orderId,
+  limit = DEFAULTS.orders.shippingAddresses.getAllBatchSize,
+  page
+}) => {
+  return import_effect10.Effect.gen(function* () {
+    const fetcher = yield* BigCommerceFetcher;
+    return yield* fetcher.fetch({
+      method: "GET",
+      path: `orders/${orderId}/products`,
+      isB2B: false,
+      version: "v2",
+      resultSchema: z9.union([z9.array(OrderShippingAddressSchema), z9.literal(""), z9.literal(null)]),
+      query: (0, import_node_querystring2.stringify)({
+        limit,
+        page
+      })
+    });
+  }).pipe(import_effect10.Effect.map((arr) => arr || []));
+};
+var getAllOrderShippingAddresses = (orderId) => {
+  return import_effect10.Effect.gen(function* () {
+    const all = [];
+    let page = 1;
+    let hasMore = true;
+    while (hasMore) {
+      const result = yield* getOrderAddresses({
+        orderId,
+        page,
+        limit: DEFAULTS.orders.shippingAddresses.getAllBatchSize
+      });
+      if (result.length) {
+        all.push(...result);
+        page++;
+      } else {
+        hasMore = false;
+      }
+    }
+    return all;
+  });
+};
 
 // src/bigcommerce-entities/orders/get-products.ts
+var import_effect11 = require("effect");
+var import_node_querystring3 = require("querystring");
+var z10 = __toESM(require("zod"));
 var getOrderProducts = ({
   orderId,
-  limit = GET_ORDER_BATCH_SIZE,
+  limit = DEFAULTS.orders.products.getAllBatchSize,
   page
 }) => {
-  return import_effect10.Effect.gen(function* () {
+  return import_effect11.Effect.gen(function* () {
     const fetcher = yield* BigCommerceFetcher;
     return yield* fetcher.fetch({
       method: "GET",
       path: `orders/${orderId}/products`,
       isB2B: false,
       version: "v2",
-      resultSchema: z8.union([z8.array(OrderProductSchema), z8.literal(""), z8.literal(null)]),
-      query: {
-        limit: `${limit}`,
-        page: `${page}`
-      }
+      resultSchema: z10.union([z10.array(OrderProductSchema), z10.literal(""), z10.literal(null)]),
+      query: (0, import_node_querystring3.stringify)({
+        limit,
+        page
+      })
     });
-  }).pipe(import_effect10.Effect.map((arr) => arr || []));
+  }).pipe(import_effect11.Effect.map((arr) => arr || []));
 };
 var getAllOrderProducts = (orderId) => {
-  return import_effect10.Effect.gen(function* () {
+  return import_effect11.Effect.gen(function* () {
     const all = [];
     let page = 1;
     let hasMore = true;
     while (hasMore) {
       const result = yield* getOrderProducts({
         orderId,
-        page,
-        limit: GET_ORDER_BATCH_SIZE
+        page
       });
       if (result.length) {
         all.push(...result);
@@ -602,12 +700,16 @@ var getAllOrderProducts = (orderId) => {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  FindOrdersCriteriaSchema,
+  OrderProductSchema,
   OrderSchema,
+  OrderShippingAddressSchema,
   OrderStatusEnum,
   OrderStatusNameEnumSchema,
   OrderStatusSchema,
   findOrders,
   getAllOrderProducts,
+  getAllOrderShippingAddresses,
   getAllOrdersBy,
   getOrder
 });