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

@benjaminlindberg/zod-mongoose

v1.1.6

Published

A library that allows you to generate mongoose schemas from zod objects.

Downloads

17

Readme

Zod to mongoose schema converter

npm version

A part of Zodyac toolbox.

This package provides a function to convert zod object to mongoose schema.

Installation

npm i @zodyac/zod-mongoose

Usage

First, create your zod schema:

import { z } from 'zod';
import { zId, zUUID } from '@zodyac/zod-mongoose';

const zUser = z.object({
  name: z.string().min(3).max(255),
  age: z.number().min(18).max(100),
  active: z.boolean().default(false),
  access: z.enum(['admin', 'user']).default('user'),
  companyId: zId.describe('ObjectId:Company'),
  wearable: zUUID.describe('UUID:Wearable'),
  address: z.object({
    street: z.string(),
    city: z.string(),
    state: z.enum(['CA', 'NY', 'TX']),
  }),
  tags: z.array(z.string()),
  createdAt: z.date(),
  updatedAt: z.date(),
});

Then, convert it to mongoose schema and connect model:

import { zodSchema } from '@zodyac/zod-mongoose';
import { model } from 'mongoose';

const schema = zodSchema(zDoc);
const userModel = model('User', schema);

That's it! Now you can use your mongoose model as usual:

userModel.find({ name: 'John' });

Features

  • ✅ Basic types
  • ✅ Nested objects and schemas
  • ✅ Arrays
  • ✅ Enums (strings only)
  • ✅ Default values
  • ✅ Dates
  • ✅ ObjectId
  • ✅ ObjectId references
  • ✅ ZodAny as SchemaTypes.Mixed
  • 🔧 UUID (experimental)
  • 🔧 UUID references (experimental)
  • ❗️ Unions (not supported by mongoose)
  • ❗️ Intersection (not supported by mongoose)
  • ❗️ Indexes (not supported by zod)
  • ❗️ Number enums (comming soon)
  • ⏳ Regex validation (comming soon)
  • ⏳ Custom validators (comming soon)
  • ⏳ instanceOf (comming soon)
  • ⏳ Transform (comming soon)
  • ⏳ Refine (comming soon)

Checking schemas

To make sure nothing is missing, you can use Schema.obj:

// schema is mongoose schema
console.log(schema.obj);

Raw object

If you want to get raw object from zod schema to modify it, you can use zodSchemaRaw function:

import { zodSchemaRaw } from '@zodyac/zod-mongoose';
import { model, Schema } from 'mongoose';

const schema = zodSchemaRaw(zDoc);
schema.age.validate = (v: number) => v > 18;

const model = model('User', new Schema(schema));

License

MIT