npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

xml-ez

v1.0.0

Published

A TypeScript library for easy conversion between Zod schemas and XML/XSD

Downloads

73

Readme

xml-ez

A TypeScript library for easy conversion between Zod schemas and XML/XSD. This library provides utilities to convert Zod schemas to XML Schema Definition (XSD) and parse XML documents into JavaScript objects.

Installation

npm install xml-ez

Features

  • Convert Zod schemas to XML Schema (XSD)
  • Parse XML strings into JavaScript objects
  • Automatic handling of array structures
  • Type-safe with full TypeScript support

Usage

Converting Zod Schema to XSD

import { z } from 'zod';
import { zodToXmlSchema } from 'xml-ez';

// Define your Zod schema
const userSchema = z.object({
  name: z.string().describe('User\'s full name'),
  age: z.number().describe('User\'s age'),
  hobbies: z.array(z.string()).describe('List of hobbies')
});

// Convert to XSD
const xsd = zodToXmlSchema(userSchema, 'User');
console.log(xsd);

Parsing XML to JavaScript Object

import { parseXmlToObject } from 'xml-ez';

const xmlString = `
<?xml version="1.0" encoding="UTF-8"?>
<User>
  <name>John Doe</name>
  <age>30</age>
  <hobbies>
    <hobby>Reading</hobby>
    <hobby>Gaming</hobby>
  </hobbies>
</User>
`;

const result = parseXmlToObject(xmlString);
console.log(result);
// Output: { name: 'John Doe', age: 30, hobbies: ['Reading', 'Gaming'] }

API Reference

zodToXmlSchema(zodSchema: z.ZodTypeAny, rootName?: string): string

Converts a Zod schema to XML Schema (XSD).

  • zodSchema: The Zod schema to convert
  • rootName: Optional name for the root element (defaults to 'Root')
  • Returns: XML Schema as a string

parseXmlToObject(xmlString: string): Record<string, any>

Parses an XML string into a JavaScript object.

  • xmlString: The XML string to parse
  • Returns: A normalized JavaScript object

License

MIT