Why is "path" an array?

[yepMad]

Why is "path" an array? At first I thought I could put ["newPassword", "repeatNewPassword"] and both fields would be triggered by react-hook-form - but no

eg.

ctx.addIssue({
        code: z.ZodIssueCode.custom,
        message: 'message',
        path: ['newPassword'],
});

[JacobWeisenburger]

path is an array of path segments, each containing a key nested under the previous path segment.

const schema = z.object( {
    foo: z.object( {
        bar: z.object( {
            baz: z.string(),
        } )
    } )
} ).deepPartial().transform( ( value, ctx ) => {
    ctx.addIssue( {
        code: z.ZodIssueCode.custom,
        message: 'message',
        path: [ 'foo', 'bar', 'baz' ],
    } )
} )
const result = schema.safeParse( {} )
!result.success && console.log( result.error.issues )
// [ { code: 'custom', message: 'message', path: [ 'foo', 'bar', 'baz' ] } ]

If you found my answer satisfactory, please consider supporting me. Even a small amount is greatly appreciated. Thanks friend! 🙏
https://github.com/sponsors/JacobWeisenburger

[nimeshmaharjan1]

but what for arrays? this doesnt work

items: z
    .array(
      z.object({
        item_id: z.number(),
        quantity: z.number().min(1, "Quantity is required"),
        total_received_quantity: z.number().optional(),
      })
    )
    .min(1, "At least one item is required.")
    .superRefine((data, ctx) => {
      data.filter((item, itemIndex) => {
        if (item.quantity > item.total_received_quantity) {
          ctx.addIssue({
            code: z.ZodIssueCode.too_big,
            message: `Quantity greater than total received quantity.`,
            path: ["items", itemIndex,toString(), "quantity"],
            type: "number",
            maximum: item.total_received_quantity,
            inclusive: true,
          });
        }
      });
    }),
  
 

[peyronoscar]

It seems like you shouldn't include "items" in the path since you are refining this field. Start with the index, which can be of type number.

[stevenprinsloo]

I am trying to access an array item, within the nested 'stores' object, which doesn't properly render the error on the field I need:

export const OTHER_BUSINESS_SCHEMA = z.object({
  merchant: OTHERMerchantSchema,
  stakeholders: z.array(StakeholderSchema).superRefine((data, ctx) => {
    // Check if there is at least one director
    const hasDirector = data.some((stakeholder) => stakeholder.businessRole === "DIRECTOR");
    if (!hasDirector) {
      ctx.addIssue({
        code: z.ZodIssueCode.custom,
        message: "At least one director is required",
      });
    }
  }),
  stores: z.array(
    z.object({
      tradingName: z.string(),
      categoryId: z.string({
        required_error: "Please select a business sub-category",
      }),
      bankAccount: BankAccountSchema,
    })
  ),
}).superRefine((data, ctx) => {
  console.log('ctx', ctx)
  /**
   * Check if the correct supporting documents are provided based on the business type
   */
  if (data.merchant.businessType === "NON_PROFIT_ORGANISATION") {
      const hasProofOfBanking = z.string().safeParse(data?.stores[0].bankAccount.supportingDocuments?.proofOfBankingUri).success;

      if (!hasProofOfBanking) {
        ctx.addIssue({
          code: z.ZodIssueCode.custom,
          message: "Proof of banking is required for an NPO/NGO.",
          path: ['stores', 0, 'bankAccount', 'supportingDocuments.proofOfBankingUri'] // <---- SEE HERE
        })
      }
  }

});;

Not sure if I am doing this correctly? 🤔

I have also tried stores[0].bankAccount.supportingDocuments.proofOfBankingUri

@peyronoscar @colinhacks are you able to help out with this one?

[stevenprinsloo]

Nevermind, figured it out, my path was wrong, should have just been:

[stores[0].supportingDocuments.proofOfBankingUri ](path: ['stores', 0, 'supportingDocuments.proofOfBankingUri'])

[colinhacks]

That path value gets appended to the path of the issue that you're creating. (Each ZodError contains an issues array with multiple issues.)

You're right that it probably could have just been a string, but I wanted to account for the possibility that someone may want to add an issue "deeply" in a nested form, for instance. I see how this could be confusing though.