@kizlo/woocommerce 0.9.0 → 0.10.0

package/README.md

@@ -42,6 +42,18 @@ pnpm add @kizlo/woocommerce
 
 See the [docs](https://kizlo.io/docs) for setup and usage.
 
+## Billing Tax IDs
+
+Billing addresses expose `taxId` on customers, carts, checkout responses, and orders. The field is always a string on output and defaults to `""` when it has not been set. Billing address inputs accept an optional `taxId`; shipping addresses never expose or persist one.
+
+```ts
+await kizlo.woocommerce.cart.update.call({
+  body: { billingAddress: { taxId: "GB123456789" } },
+})
+```
+
+Store administrators can make the field mandatory from **WooCommerce → Settings → Accounts & Privacy → Checkout → Require Tax ID at checkout**. It remains optional by default.
+
 ## License
 
-[Apache 2.0](./LICENSE) © Kizlo
+[Apache 2.0](./LICENSE) © Kizlo

package/dist/index.d.ts

@@ -29,6 +29,7 @@ declare const CartShippingAddress: z$1.ZodObject<{
 type CartShippingAddress = z$1.infer<typeof CartShippingAddress>;
 declare const CartBillingAddress: z$1.ZodObject<{
   email: z$1.ZodString;
+  taxId: z$1.ZodDefault<z$1.ZodString>;
   firstName: z$1.ZodString;
   lastName: z$1.ZodString;
   company: z$1.ZodString;
@@ -344,6 +345,7 @@ declare const Cart: z$1.ZodObject<{
   itemsWeight: z$1.ZodNumber;
   billingAddress: z$1.ZodObject<{
     email: z$1.ZodString;
+    taxId: z$1.ZodDefault<z$1.ZodString>;
     firstName: z$1.ZodString;
     lastName: z$1.ZodString;
     company: z$1.ZodString;
@@ -619,6 +621,7 @@ declare const UpdateCartInput: z$1.ZodObject<{
   }, z$1.core.$strip>>;
   billingAddress: z$1.ZodOptional<z$1.ZodObject<{
     email: z$1.ZodOptional<z$1.ZodString>;
+    taxId: z$1.ZodOptional<z$1.ZodDefault<z$1.ZodString>>;
     firstName: z$1.ZodOptional<z$1.ZodString>;
     lastName: z$1.ZodOptional<z$1.ZodString>;
     company: z$1.ZodOptional<z$1.ZodString>;
@@ -663,6 +666,7 @@ declare const Checkout: z$2.ZodObject<{
   customerNote: z$2.ZodString;
   billingAddress: z$2.ZodObject<{
     email: z$2.ZodString;
+    taxId: z$2.ZodDefault<z$2.ZodString>;
     firstName: z$2.ZodString;
     lastName: z$2.ZodString;
     company: z$2.ZodString;
@@ -770,6 +774,7 @@ declare const Checkout: z$2.ZodObject<{
     itemsWeight: z$2.ZodNumber;
     billingAddress: z$2.ZodObject<{
       email: z$2.ZodString;
+      taxId: z$2.ZodDefault<z$2.ZodString>;
       firstName: z$2.ZodString;
       lastName: z$2.ZodString;
       company: z$2.ZodString;
@@ -1008,6 +1013,7 @@ type UpdateCheckoutInput = z$2.input<typeof UpdateCheckoutInput>;
 declare const ConfirmCheckoutInput: z$2.ZodObject<{
   billingAddress: z$2.ZodObject<{
     email: z$2.ZodString;
+    taxId: z$2.ZodDefault<z$2.ZodString>;
     firstName: z$2.ZodString;
     lastName: z$2.ZodString;
     company: z$2.ZodString;
@@ -1054,6 +1060,7 @@ declare const RetryCheckoutInput: z$2.ZodObject<{
   billingEmail: z$2.ZodOptional<z$2.ZodEmail>;
   billingAddress: z$2.ZodObject<{
     email: z$2.ZodString;
+    taxId: z$2.ZodDefault<z$2.ZodString>;
     firstName: z$2.ZodString;
     lastName: z$2.ZodString;
     company: z$2.ZodString;
@@ -1132,6 +1139,7 @@ declare const OrderItem: z.ZodObject<{
   id: z.ZodNumber;
   productId: z.ZodNullable<z.ZodNumber>;
   variationId: z.ZodNullable<z.ZodNumber>;
+  hsCode: z.ZodNullable<z.ZodString>;
   name: z.ZodString;
   quantity: z.ZodNumber;
   selectedAttributes: z.ZodArray<z.ZodObject<{
@@ -1225,6 +1233,7 @@ declare const Order: z.ZodObject<{
     id: z.ZodNumber;
     productId: z.ZodNullable<z.ZodNumber>;
     variationId: z.ZodNullable<z.ZodNumber>;
+    hsCode: z.ZodNullable<z.ZodString>;
     name: z.ZodString;
     quantity: z.ZodNumber;
     selectedAttributes: z.ZodArray<z.ZodObject<{
@@ -1296,6 +1305,7 @@ declare const Order: z.ZodObject<{
   }, z.core.$strip>>;
   billingAddress: z.ZodObject<{
     email: z.ZodString;
+    taxId: z.ZodDefault<z.ZodString>;
     firstName: z.ZodString;
     lastName: z.ZodString;
     company: z.ZodString;
@@ -2035,6 +2045,7 @@ declare const Product: z.ZodObject<{
   formattedWeight: z.ZodString;
   formattedDimensions: z.ZodString;
   stockQuantity: z.ZodNullable<z.ZodNumber>;
+  hsCode: z.ZodNullable<z.ZodString>;
   saleStartsAt: z.ZodNullable<z.ZodNumber>;
   saleEndsAt: z.ZodNullable<z.ZodNumber>;
   seo: z.ZodNullable<z.ZodObject<{
@@ -2537,6 +2548,7 @@ declare const ProductList: z.ZodObject<{
     formattedWeight: z.ZodString;
     formattedDimensions: z.ZodString;
     stockQuantity: z.ZodNullable<z.ZodNumber>;
+    hsCode: z.ZodNullable<z.ZodString>;
     saleStartsAt: z.ZodNullable<z.ZodNumber>;
     saleEndsAt: z.ZodNullable<z.ZodNumber>;
     seo: z.ZodNullable<z.ZodObject<{
@@ -3459,6 +3471,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       itemsWeight: number;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -3708,6 +3721,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         } | undefined;
         billingAddress?: {
           email?: string | undefined;
+          taxId?: string | undefined;
           firstName?: string | undefined;
           lastName?: string | undefined;
           company?: string | undefined;
@@ -3797,6 +3811,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       itemsWeight: number;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -4115,6 +4130,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       itemsWeight: number;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -4443,6 +4459,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -4787,6 +4804,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -5120,6 +5138,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -5439,6 +5458,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -5760,6 +5780,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -6194,6 +6215,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       customerNote: string;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -6311,6 +6333,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -6570,6 +6593,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       customerNote: string;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -6687,6 +6711,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -7018,6 +7043,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -7320,6 +7346,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -7622,6 +7649,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -7924,6 +7952,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -8226,6 +8255,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -8470,6 +8500,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
           additionalFields: {
             [x: string]: string | boolean;
           };
+          taxId?: string | undefined;
         };
         paymentMethod: string;
         shippingAddress?: {
@@ -8507,6 +8538,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       customerNote: string;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -8624,6 +8656,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -8999,6 +9032,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -9301,6 +9335,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -9603,6 +9638,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -9905,6 +9941,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -10207,6 +10244,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -10509,6 +10547,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -10811,6 +10850,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
             itemsWeight: zod0.ZodNumber;
             billingAddress: zod0.ZodObject<{
               email: zod0.ZodString;
+              taxId: zod0.ZodDefault<zod0.ZodString>;
               firstName: zod0.ZodString;
               lastName: zod0.ZodString;
               company: zod0.ZodString;
@@ -11055,6 +11095,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
           additionalFields: {
             [x: string]: string | boolean;
           };
+          taxId?: string | undefined;
         };
         key: string;
         paymentMethod: string;
@@ -11095,6 +11136,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
       customerNote: string;
       billingAddress: {
         email: string;
+        taxId: string;
         firstName: string;
         lastName: string;
         company: string;
@@ -11212,6 +11254,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         itemsWeight: number;
         billingAddress: {
           email: string;
+          taxId: string;
           firstName: string;
           lastName: string;
           company: string;
@@ -11507,6 +11550,7 @@ declare function woocommerce(): kizlo0.Integration<"woocommerce", {
         state: string;
         country: string;
         email: string;
+        taxId: string;
         company?: string | undefined;
         address2?: string | undefined;
       };

package/dist/index.js

@@ -314,6 +314,7 @@ const Product = ProductSummary.extend({
 	formattedWeight: z.string(),
 	formattedDimensions: z.string(),
 	stockQuantity: z.number().nullable(),
+	hsCode: z.string().nullable(),
 	saleStartsAt: z.number().nullable(),
 	saleEndsAt: z.number().nullable(),
 	seo: Seo.nullable(),
@@ -501,7 +502,8 @@ const CartAddressFields = {
 const CartShippingAddress = z$1.object(CartAddressFields);
 const CartBillingAddress = z$1.object({
 	...CartAddressFields,
-	email: z$1.string()
+	email: z$1.string(),
+	taxId: z$1.string().default("")
 });
 const CartShippingDestination = z$1.object({
 	address1: z$1.string(),
@@ -675,10 +677,7 @@ const SelectCartShippingRateInput = z$1.object({
 	packageId: z$1.union([z$1.number(), z$1.string()]).nullable().optional()
 });
 const CartShippingAddressInput = z$1.object(CartAddressFields).partial();
-const CartBillingAddressInput = z$1.object({
-	...CartAddressFields,
-	email: z$1.string()
-}).partial();
+const CartBillingAddressInput = CartBillingAddress.partial();
 const UpdateCartInput = z$1.object({
 	shippingAddress: CartShippingAddressInput.optional(),
 	billingAddress: CartBillingAddressInput.optional()
@@ -701,6 +700,7 @@ function deserializeStoreProduct(data, recommendations) {
 		formattedWeight: data.formatted_weight,
 		formattedDimensions: data.formatted_dimensions,
 		stockQuantity: nullableNumber(kizlo.stock),
+		hsCode: typeof kizlo.hs_code === "string" && kizlo.hs_code !== "" ? kizlo.hs_code : null,
 		saleStartsAt: timestampFromIso(typeof kizlo.on_sale_from === "string" ? kizlo.on_sale_from : null),
 		saleEndsAt: timestampFromIso(typeof kizlo.on_sale_to === "string" ? kizlo.on_sale_to : null),
 		seo: isRecord$1(kizlo.seo) ? deserializeSeo(kizlo.seo) : null,
@@ -931,6 +931,7 @@ function nullableNumber(value) {
 
 //#endregion
 //#region src/cart/utils.ts
+const TAX_ID_KEY = "kizlo/tax-id";
 function assertNoMissing$2() {}
 assertNoMissing$2();
 assertNoMissing$2();
@@ -1139,6 +1140,7 @@ function deserializeCartBillingAddress(address) {
 	return {
 		...deserializeCartShippingAddress(address),
 		email: address.email,
+		taxId: taxId(address),
 		additionalFields: additionalAddressFields(address, BILLING_ADDRESS_KEYS)
 	};
 }
@@ -1152,12 +1154,16 @@ const SHIPPING_ADDRESS_KEYS = new Set([
 	"state",
 	"postcode",
 	"country",
-	"phone"
+	"phone",
+	TAX_ID_KEY
 ]);
 const BILLING_ADDRESS_KEYS = new Set([...SHIPPING_ADDRESS_KEYS, "email"]);
 function additionalAddressFields(address, standardKeys) {
 	return Object.fromEntries(Object.entries(address).filter((entry) => !standardKeys.has(entry[0]) && (typeof entry[1] === "string" || typeof entry[1] === "boolean")));
 }
+function taxId(address) {
+	return typeof address[TAX_ID_KEY] === "string" ? address[TAX_ID_KEY] : "";
+}
 function serializeCartUpdateInput(input) {
 	return {
 		...input.billingAddress !== void 0 && { billing_address: serializeCartBillingAddress(input.billingAddress) },
@@ -1166,7 +1172,7 @@ function serializeCartUpdateInput(input) {
 }
 function serializeCartShippingAddress(address) {
 	return compactAddress({
-		...address.additionalFields,
+		...Object.fromEntries(Object.entries(address.additionalFields ?? {}).filter(([key]) => key !== TAX_ID_KEY)),
 		first_name: address.firstName,
 		last_name: address.lastName,
 		company: address.company,
@@ -1182,7 +1188,8 @@ function serializeCartShippingAddress(address) {
 function serializeCartBillingAddress(address) {
 	return compactAddress({
 		...serializeCartShippingAddress(address),
-		email: address.email
+		email: address.email,
+		[TAX_ID_KEY]: address.taxId
 	});
 }
 function compactAddress(address) {
@@ -1960,7 +1967,10 @@ const ShippingAddress = z$1.object({
 	state: z$1.string(),
 	country: z$1.string()
 });
-const BillingAddress = ShippingAddress.extend({ email: z$1.string() });
+const BillingAddress = ShippingAddress.extend({
+	email: z$1.string(),
+	taxId: z$1.string().default("")
+});
 
 //#endregion
 //#region src/customer/schema.ts
@@ -1982,21 +1992,23 @@ const Customer = z$2.object({
 //#endregion
 //#region src/customer/utils.ts
 function deserializeCustomer(data) {
+	const billing = data.billing;
 	return {
 		id: data.id,
 		avatarUrl: data.avatar_url.length ? data.avatar_url : null,
 		billing: {
-			firstName: data.billing.first_name,
-			lastName: data.billing.last_name,
-			address1: data.billing.address_1,
-			city: data.billing.city,
-			country: data.billing.country,
-			email: data.billing.email,
-			phone: data.billing.phone,
-			postcode: data.billing.postcode,
-			state: data.billing.state,
-			address2: data.billing.address_2,
-			company: data.billing.company
+			firstName: billing.first_name,
+			lastName: billing.last_name,
+			address1: billing.address_1,
+			city: billing.city,
+			country: billing.country,
+			email: billing.email,
+			phone: billing.phone,
+			postcode: billing.postcode,
+			state: billing.state,
+			address2: billing.address_2,
+			company: billing.company,
+			taxId: typeof billing.tax_id === "string" ? billing.tax_id : ""
 		},
 		shipping: {
 			firstName: data.shipping.first_name,
@@ -2078,6 +2090,7 @@ const OrderItem = z.object({
 	id: z.number(),
 	productId: z.number().nullable(),
 	variationId: z.number().nullable(),
+	hsCode: z.string().nullable(),
 	name: z.string(),
 	quantity: z.number(),
 	selectedAttributes: z.array(CartSelectedAttribute),
@@ -2209,6 +2222,7 @@ function deserializeOrderItem(item) {
 		id: item.id,
 		productId,
 		variationId,
+		hsCode: typeof kizlo.hs_code === "string" && kizlo.hs_code !== "" ? kizlo.hs_code : null,
 		name: item.name,
 		quantity: item.quantity,
 		selectedAttributes: item.variation.map((attribute) => ({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kizlo/woocommerce",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "type": "module",
   "sideEffects": false,
   "description": "WooCommerce integration for Kizlo.",