headless: update plugin (#317)

* save * lock * imp * lint * changeset
goat-sdk · Feb 7, 2025 · ca7611b · ca7611b
1 parent fb76f39
commit ca7611b
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 37 deletions.
diff --git a/biome.json b/biome.json
diff --git a/typescript/.changeset/strong-owls-hug.md b/typescript/.changeset/strong-owls-hug.md
@@ -0,0 +1,5 @@
+---
+"@goat-sdk/plugin-crossmint-headless-checkout": patch
+---
+
+headless: tweak plugin
diff --git a/typescript/packages/plugins/crossmint-headless-checkout/package.json b/typescript/packages/plugins/crossmint-headless-checkout/package.json
@@ -14,7 +14,7 @@
     "dependencies": {
         "@goat-sdk/core": "workspace:*",
         "@crossmint/common-sdk-base": "0.3.1",
-        "@crossmint/client-sdk-base": "1.4.4",
+        "@crossmint/client-sdk-base": "1.4.6",
         "@goat-sdk/wallet-evm": "workspace:*",
         "viem": "catalog:",
         "zod": "catalog:"

diff --git a/...pt/packages/plugins/crossmint-headless-checkout/src/crossmint-headless-checkout.plugin.ts b/...pt/packages/plugins/crossmint-headless-checkout/src/crossmint-headless-checkout.plugin.ts
@@ -14,7 +14,7 @@ export class CrossmintHeadlessCheckoutPlugin extends PluginBase {
 
     constructor(
         private readonly crossmint: Crossmint,
-        private readonly callDataSchema: z.ZodSchema,
+        private readonly callDataSchema?: z.ZodSchema,
     ) {
         super("crossmint-headless-checkout", []);
 
@@ -32,7 +32,7 @@ export class CrossmintHeadlessCheckoutPlugin extends PluginBase {
     }
 
     supportsChain(chain: Chain): boolean {
-        return chain.type === "evm"; // TODO: Add support for more blockchains
+        return true;
     }
 
     async getTools(walletClient: EVMWalletClient) {
@@ -65,7 +65,10 @@ export class CrossmintHeadlessCheckoutPlugin extends PluginBase {
                         throw new Error(errorMessage);
                     }
 
-                    const { order } = (await res.json()) as { order: Order; orderClientSecret: string };
+                    const { order } = (await res.json()) as {
+                        order: Order;
+                        orderClientSecret: string;
+                    };
 
                     console.log("Created order:", order.orderId);
 
@@ -74,13 +77,22 @@ export class CrossmintHeadlessCheckoutPlugin extends PluginBase {
                         throw new Error("Insufficient funds");
                     }
 
+                    const isRequiresPhysicalAddress = order.quote.status === "requires-physical-address";
+                    if (isRequiresPhysicalAddress) {
+                        throw new Error("recipient.physicalAddress is required");
+                    }
+
                     const serializedTransaction =
                         order.payment.preparation != null && "serializedTransaction" in order.payment.preparation
                             ? order.payment.preparation.serializedTransaction
                             : undefined;
                     if (!serializedTransaction) {
                         throw new Error(
-                            `No serialized transaction found for order, this item may not be available for purchase:\n\n ${JSON.stringify(order, null, 2)}`,
+                            `No serialized transaction found for order, this item may not be available for purchase:\n\n ${JSON.stringify(
+                                order,
+                                null,
+                                2,
+                            )}`,
                         );
                     }
 
@@ -104,6 +116,6 @@ export class CrossmintHeadlessCheckoutPlugin extends PluginBase {
     }
 }
 
-export const crossmintHeadlessCheckout = (crossmint: Crossmint, callDataSchema: z.ZodSchema) => {
+export const crossmintHeadlessCheckout = (crossmint: Crossmint, callDataSchema?: z.ZodSchema) => {
     return new CrossmintHeadlessCheckoutPlugin(crossmint, callDataSchema);
 };
diff --git a/typescript/packages/plugins/crossmint-headless-checkout/src/parameters.ts b/typescript/packages/plugins/crossmint-headless-checkout/src/parameters.ts
@@ -5,15 +5,17 @@ import { z } from "zod";
  * @param callDataSchema - Schema for contract-specific call data validation
  * @returns Zod schema object defining the structure of order parameters
  */
-export function getCreateAndPayOrderParameters(callDataSchema: z.ZodSchema) {
+export function getCreateAndPayOrderParameters(callDataSchema?: z.ZodSchema) {
     return z.object({
         recipient: z
             .union([
                 z.object({
                     walletAddress: z.string(),
+                    physicalAddress: physicalAddressSchema.optional(),
                 }),
                 z.object({
                     email: z.string().email(),
+                    physicalAddress: physicalAddressSchema.optional(),
                 }),
             ])
             .describe(
@@ -33,15 +35,57 @@ export function getCreateAndPayOrderParameters(callDataSchema: z.ZodSchema) {
             ),
         lineItems: z
             .array(
-                z.object({
-                    collectionLocator: z
-                        .string()
-                        .describe(
-                            "The collection locator. Ex: 'crossmint:<crossmint_collection_id>', '<chain>:<contract_address>'",
-                        ), // TODO: Add tokenLocator support
-                    callData: callDataSchema,
-                }),
+                // TODO: Add tokenLocator support
+                z.union([
+                    z.object({
+                        collectionLocator: z
+                            .string()
+                            .describe(
+                                "The collection locator. Ex: 'crossmint:<crossmint_collection_id>', '<chain>:<contract_address>'",
+                            ),
+                        ...(callDataSchema ? { callData: callDataSchema } : {}),
+                    }),
+                    z.object({
+                        productLocator: z
+                            .string()
+                            .describe("The product locator. Ex: 'amazon:<amazon_product_id>', 'amazon:<asin>'"),
+                        ...(callDataSchema ? { callData: callDataSchema } : {}),
+                    }),
+                ]),
             )
             .describe("Array of items to purchase"),
     });
 }
+
+export const physicalAddressSchema = z
+    .object({
+        name: z.string().min(1, "Name is required for physical address"),
+        line1: z.string().min(1, "Line 1 is required for physical address"),
+        line2: z.string().optional(),
+        city: z.string().min(1, "City is required for physical address"),
+
+        state: z.string().optional().describe("State/Province/Region - optional"),
+        postalCode: z.string().min(1, "Postal/ZIP code is required for physical address"),
+        country: z
+            .string()
+            .min(2, "Country is required for physical address")
+            .max(2, "Country must be a 2-letter ISO code for physical address")
+            .toUpperCase(),
+    })
+    .superRefine((data, ctx) => {
+        // TODO: allow more countries
+        if (data.country !== "US") {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                message: "Only 'US' country code is supported at this time",
+            });
+        }
+
+        if (data.country === "US" && !data.state) {
+            ctx.addIssue({
+                code: z.ZodIssueCode.custom,
+                message: "State is required for US physical address",
+            });
+        }
+    })
+    .describe("International mailing address using ISO 3166-1 alpha-2 country codes");
diff --git a/typescript/pnpm-lock.yaml b/typescript/pnpm-lock.yaml