Maxiviper117
Maxiviper117
PostsComments
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
The whole use case for this was validating data that would be used to create a Shopify customer via API, where customers on a clients account could have any number of additional metafields that hold extra information apart from the standard. And those metafields need to have that format when recevied to be able to easily parse them to send them correctly to each clients Shopify account to create a customer with unique metafields.
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
your last example works well to get all errors at once, appreciate the time taken.
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
yes just made the correction in case you were testing it your side and seeing nothing
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
small error in the regex this is the corrected one: 
const regex = /^metafield\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$/;
const regex = /^metafield\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$/;
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
Yes but then I have no control on the error messages it produces. And would have to do manual processing afterwards
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
Problem I mention earlier is if validation failed on known keys then the narrow errors were ignored.
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
In this case with this Zod type I would be able to collect all errors at once
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
Error shown as : 
[
  {
    code: "invalid_type",
    expected: "string",
    received: "undefined",
    path: [ "knownKey" ],
    message: "Required",
  }, {
    validation: "email",
    code: "invalid_string",
    message: "Invalid email",
    path: [ "email" ],
  }, {
    fatal: true,
    code: "unrecognized_keys",
    keys: [ "knownKey1", "email", "metafield.1", "not_meta_field" ],
    message: "If you meant to use a metafield, it should be in the format \"metafield.<namespace>.<key>.\"",
    path: [],
  }
]
[
  {
    code: "invalid_type",
    expected: "string",
    received: "undefined",
    path: [ "knownKey" ],
    message: "Required",
  }, {
    validation: "email",
    code: "invalid_string",
    message: "Invalid email",
    path: [ "email" ],
  }, {
    fatal: true,
    code: "unrecognized_keys",
    keys: [ "knownKey1", "email", "metafield.1", "not_meta_field" ],
    message: "If you meant to use a metafield, it should be in the format \"metafield.<namespace>.<key>.\"",
    path: [],
  }
]
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
But if you are interested in a comparison to Zod, someone came up with this in Zod: 
import { z } from "zod";

const metaFieldRegex = new RegExp("^metafield.[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+$");

type ObjectWithMetaFields = {
    [K: `metafield.${string}.${string}`]: string;
};

const schema = z.intersection(
    z.object({
        knownKey: z.string(),
        email: z.string().email(),
    }),
    z
        .record(z.string())
        .superRefine((obj, ctx): obj is ObjectWithMetaFields => {
            delete obj["knownKey"]; // remove knownKey from the object to validate only meta fields

            const keys = Object.keys(obj);

            // Collect all keys that are not in the format "metafield.<namespace>.<key>"
            const invalidKeys = keys.filter(
                (x) => metaFieldRegex.test(x) === false
            );

            if (invalidKeys.length > 0) {
                ctx.addIssue({
                    fatal: true,
                    code: "unrecognized_keys",
                    keys: invalidKeys,
                    message: `If you meant to use a metafield, it should be in the format "metafield.<namespace>.<key>."`,
                });
            }

            return z.NEVER;
        })
);


const example = {
    knownKey1: "valid",
    email: "exampletest.com",
    "metafield.1": "errors_on_bad_meta_key",
    not_meta_field: "errors_on_disallowed_key",
    "metafield.test.test": "valid_key",
};

try {
    const result = schema.parse(example);
} catch (error) {
    if (error instanceof z.ZodError) {
        console.log(error.errors); // This will show the validation errors
    } else {
        console.error("Unexpected error:", error);
    }
}
import { z } from "zod";

const metaFieldRegex = new RegExp("^metafield.[a-zA-Z0-9_-]+.[a-zA-Z0-9_-]+$");

type ObjectWithMetaFields = {
    [K: `metafield.${string}.${string}`]: string;
};

const schema = z.intersection(
    z.object({
        knownKey: z.string(),
        email: z.string().email(),
    }),
    z
        .record(z.string())
        .superRefine((obj, ctx): obj is ObjectWithMetaFields => {
            delete obj["knownKey"]; // remove knownKey from the object to validate only meta fields

            const keys = Object.keys(obj);

            // Collect all keys that are not in the format "metafield.<namespace>.<key>"
            const invalidKeys = keys.filter(
                (x) => metaFieldRegex.test(x) === false
            );

            if (invalidKeys.length > 0) {
                ctx.addIssue({
                    fatal: true,
                    code: "unrecognized_keys",
                    keys: invalidKeys,
                    message: `If you meant to use a metafield, it should be in the format "metafield.<namespace>.<key>."`,
                });
            }

            return z.NEVER;
        })
);


const example = {
    knownKey1: "valid",
    email: "exampletest.com",
    "metafield.1": "errors_on_bad_meta_key",
    not_meta_field: "errors_on_disallowed_key",
    "metafield.test.test": "valid_key",
};

try {
    const result = schema.parse(example);
} catch (error) {
    if (error instanceof z.ZodError) {
        console.log(error.errors); // This will show the validation errors
    } else {
        console.error("Unexpected error:", error);
    }
}
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
I figured that If I wanted this type of operation for this narrow use case, I would probably have to split it up.
25 replies
ZZod
Created by Maxiviper117 on 4/2/2025 in #questions
Maxiviper117 - I'm working on validating an obj...
@Sikari Thanks Added this to superRefine(): 
delete obj["knownKey"];
delete obj["knownKey"];
To exclude known keys from being checked against the regex.
7 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
Seems like the issue is that when there's a type invalidation from type({}), it takes precedence and overrides any ArkError added via ctx.reject in a narrow() expression. So even if narrow() adds its own errors, they get ignored unless the known keys type check passes in type({}). But the issue is that I might want to collect all errors to send back in a response—so the user sees everything that failed validation at once, rather than fixing one thing, resubmitting, hitting the next error, and repeating that cycle.
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
No description
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
Nice but then what about custom error message, otherwise it shows that all extra invalid keys must be removed.
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
This data would cause this error 
// Test case with invalid data
const invalidData = {
    knownkey: "some value",
    "metafie2ld.test.key": "value1",
    "invalid.key": "value2", // Invalid key pattern
};

// Validate the data
const invalidResult = myType(invalidData);

console.log("\nInvalid data result:");
if (invalidResult instanceof type.errors) {
    console.error(invalidResult.summary);
} else {
    console.log("Validation passed:", invalidResult);
}
// Test case with invalid data
const invalidData = {
    knownkey: "some value",
    "metafie2ld.test.key": "value1",
    "invalid.key": "value2", // Invalid key pattern
};

// Validate the data
const invalidResult = myType(invalidData);

console.log("\nInvalid data result:");
if (invalidResult instanceof type.errors) {
    console.error(invalidResult.summary);
} else {
    console.log("Validation passed:", invalidResult);
}
Invalid data result:
value at ["metafie2ld.test.key"] must be key must match metafield.<namespace>.<key> (was metafie2ld.test.key)
value at ["invalid.key"] must be key must match metafield.<namespace>.<key> (was invalid.key)
Invalid data result:
value at ["metafie2ld.test.key"] must be key must match metafield.<namespace>.<key> (was metafie2ld.test.key)
value at ["invalid.key"] must be key must match metafield.<namespace>.<key> (was invalid.key)
and this data would cause this error (missing metafield errors) 
// Test case with invalid data
const invalidData = {
    knownkey: "some value",
    // email: "[email protected]",
    "metafie2ld.test.key": "value1",
    "invalid.key": "value2", // Invalid key pattern
};

// Validate the data
const invalidResult = myType(invalidData);

console.log("\nInvalid data result:");
if (invalidResult instanceof type.errors) {
    console.error(invalidResult.summary);
} else {
    console.log("Validation passed:", invalidResult);
}
// Test case with invalid data
const invalidData = {
    knownkey: "some value",
    // email: "[email protected]",
    "metafie2ld.test.key": "value1",
    "invalid.key": "value2", // Invalid key pattern
};

// Validate the data
const invalidResult = myType(invalidData);

console.log("\nInvalid data result:");
if (invalidResult instanceof type.errors) {
    console.error(invalidResult.summary);
} else {
    console.log("Validation passed:", invalidResult);
}
Invalid data result:
email must be a string (was missing)
Invalid data result:
email must be a string (was missing)
What am I doing wrong or missing ?
25 replies
Aarktype
Created by Maxiviper117 on 4/1/2025 in #questions
Key validation on arbitrary number of properties.
My attempt: but issue is if known keys cause error then all invalid metafield invalidation errors excluded from .summery unless they are the only errors: 
import { type } from "arktype";

// Define the Arktype schema
const myType = type({
    // Known properties with specific types
    knownkey: "string",
    email: "string.email",
}).narrow((data, ctx) => {
    // Regex for extra keys
    const regex = /^metafield\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$/;

    // List of known keys
    const knownKeys = new Set(["knownkey", "email"]);

    // Iterate over all keys in the data object
    for (let key of Object.keys(data)) {
        // If the key is not one of the known keys, validate it against the regex
        if (!knownKeys.has(key)) {
            if (!regex.test(key)) {
                
                ctx.reject({
                    expected: "key must match metafield.<namespace>.<key>",
                    actual: key,
                    path: [key],
                });
            }
        }
    }
    return true; 
});
import { type } from "arktype";

// Define the Arktype schema
const myType = type({
    // Known properties with specific types
    knownkey: "string",
    email: "string.email",
}).narrow((data, ctx) => {
    // Regex for extra keys
    const regex = /^metafield\.[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+$/;

    // List of known keys
    const knownKeys = new Set(["knownkey", "email"]);

    // Iterate over all keys in the data object
    for (let key of Object.keys(data)) {
        // If the key is not one of the known keys, validate it against the regex
        if (!knownKeys.has(key)) {
            if (!regex.test(key)) {
                
                ctx.reject({
                    expected: "key must match metafield.<namespace>.<key>",
                    actual: key,
                    path: [key],
                });
            }
        }
    }
    return true; 
});
25 replies