nuxt-feathers-zod 0.1.0

package/dist/runtime/templates/server/validators.js

@@ -0,0 +1,30 @@
+import { put } from "../utils.js";
+export function getServerValidatorContents(options) {
+  return () => {
+    const formats = options?.validator?.formats;
+    const mongo = !!options?.database?.mongo;
+    return `// ! Generated by nuxt-feathers-zod - do not change manually
+// For more information about this file see https://dove.feathersjs.com/guides/cli/validators.html
+
+${put(mongo, `import { keywordObjectId } from '@feathersjs/mongodb'`)}
+import type { FormatsPluginOptions } from '@feathersjs/schema'
+import { addFormats, Ajv } from '@feathersjs/schema'
+
+const formats: FormatsPluginOptions = [
+  '${formats?.join(`',
+  '`)}'
+]
+
+export const dataValidator: Ajv = addFormats(new Ajv({}), formats)
+
+export const queryValidator: Ajv = addFormats(
+  new Ajv({
+    coerceTypes: true,
+  }),
+  formats,
+)  
+${put(mongo, `
+dataValidator.addKeyword(keywordObjectId)
+queryValidator.addKeyword(keywordObjectId)`)}`;
+  };
+}

package/dist/runtime/templates/types.d.ts

@@ -0,0 +1,6 @@
+import type { NuxtTemplate } from 'nuxt/schema';
+import type { ModuleConfig } from '../options/index.js';
+export type GetContentsType = Required<NuxtTemplate<ModuleConfig>>['getContents'];
+export type GetContentsDataType = Parameters<GetContentsType>[0];
+export type Template = Required<Pick<NuxtTemplate, 'filename' | 'getContents' | 'write'>>;
+export type Templates = Array<Template>;

package/dist/runtime/templates/utils.d.ts

@@ -0,0 +1,4 @@
+type putData = [expr: any, content: string, def?: string];
+export declare function put(expr: any, content: string, def?: string): string;
+export declare function puts(puts: putData[]): string;
+export {};

package/dist/runtime/templates/utils.js

@@ -0,0 +1,6 @@
+export function put(expr, content, def = "") {
+  return expr ? content : def;
+}
+export function puts(puts2) {
+  return puts2.map((p) => put(p[0], p[1], p?.[2])).filter(Boolean).join("\n");
+}

package/dist/runtime/zod/format.d.ts

@@ -0,0 +1,10 @@
+import type { ZodError } from 'zod';
+export interface ZodIssueItem {
+    path: string;
+    code: string;
+    message: string;
+}
+/**
+ * Formats Zod issues into a stable, UI-friendly structure.
+ */
+export declare function formatZodIssues(err: ZodError): ZodIssueItem[];

package/dist/runtime/zod/format.js

@@ -0,0 +1,7 @@
+export function formatZodIssues(err) {
+  return err.issues.map((i) => ({
+    path: i.path.length ? i.path.join(".") : "",
+    code: i.code,
+    message: i.message
+  }));
+}

package/dist/runtime/zod/index.d.ts

@@ -0,0 +1,4 @@
+export { formatZodIssues } from './format.js';
+export { objectIdSchema } from './objectId.js';
+export { queryPropertiesShape, queryProperty, sortDefinition, zodQuerySyntax } from './query.js';
+export { getZodValidator } from './validators.js';

package/dist/runtime/zod/index.js

@@ -0,0 +1,4 @@
+export { formatZodIssues } from "./format.js";
+export { objectIdSchema } from "./objectId.js";
+export { queryPropertiesShape, queryProperty, sortDefinition, zodQuerySyntax } from "./query.js";
+export { getZodValidator } from "./validators.js";

package/dist/runtime/zod/objectId.d.ts

@@ -0,0 +1,9 @@
+import { ObjectId } from 'mongodb';
+import { z } from 'zod';
+/**
+ * MongoDB ObjectId schema that accepts:
+ * - ObjectId instances
+ * - 24-hex strings (converted to ObjectId)
+ * - undefined (optional)
+ */
+export declare function objectIdSchema(): z.ZodUnion<[z.ZodOptional<z.ZodType<ObjectId, z.ZodTypeDef, ObjectId>>, z.ZodEffects<z.ZodString, ObjectId, string>]>;

package/dist/runtime/zod/objectId.js

@@ -0,0 +1,17 @@
+import { ObjectId } from "mongodb";
+import { z } from "zod";
+export function objectIdSchema() {
+  return z.instanceof(ObjectId).optional().or(
+    z.string().transform((input, ctx) => {
+      try {
+        return ObjectId.createFromHexString(input);
+      } catch (err) {
+        ctx.addIssue({
+          code: z.ZodIssueCode.custom,
+          message: err?.message ?? "Invalid ObjectId"
+        });
+        return z.NEVER;
+      }
+    })
+  );
+}

package/dist/runtime/zod/query.d.ts

@@ -0,0 +1,43 @@
+import { z, type ZodRawShape, type ZodTypeAny } from 'zod';
+type KeysOf<Shape extends ZodRawShape> = Extract<keyof Shape, string>;
+export declare function sortDefinition<Shape extends ZodRawShape>(shape: Shape): z.ZodObject<Record<string, z.ZodTypeAny>, "strict", z.ZodTypeAny, {
+    [x: string]: any;
+}, {
+    [x: string]: any;
+}>;
+export declare function queryProperty<T extends ZodTypeAny, X extends Record<string, ZodTypeAny> = {}>(prop: T, extension?: X): z.ZodUnion<[z.ZodOptional<z.ZodNullable<T>>, z.ZodObject<{
+    $ne: z.ZodOptional<z.ZodOptional<z.ZodNullable<T>>>;
+    $gt: z.ZodOptional<z.ZodOptional<T>>;
+    $gte: z.ZodOptional<z.ZodOptional<T>>;
+    $lt: z.ZodOptional<z.ZodOptional<T>>;
+    $lte: z.ZodOptional<z.ZodOptional<T>>;
+    $in: z.ZodOptional<z.ZodArray<z.ZodOptional<z.ZodNullable<T>>, "many">>;
+    $nin: z.ZodOptional<z.ZodArray<z.ZodOptional<z.ZodNullable<T>>, "many">>;
+} & X, "strict", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<{
+    $ne: z.ZodOptional<z.ZodOptional<z.ZodNullable<T>>>;
+    $gt: z.ZodOptional<z.ZodOptional<T>>;
+    $gte: z.ZodOptional<z.ZodOptional<T>>;
+    $lt: z.ZodOptional<z.ZodOptional<T>>;
+    $lte: z.ZodOptional<z.ZodOptional<T>>;
+    $in: z.ZodOptional<z.ZodArray<z.ZodOptional<z.ZodNullable<T>>, "many">>;
+    $nin: z.ZodOptional<z.ZodArray<z.ZodOptional<z.ZodNullable<T>>, "many">>;
+} & X>, any> extends infer T_1 ? { [k in keyof T_1]: T_1[k]; } : never, z.baseObjectInputType<{
+    $ne: z.ZodOptional<z.ZodOptional<z.ZodNullable<T>>>;
+    $gt: z.ZodOptional<z.ZodOptional<T>>;
+    $gte: z.ZodOptional<z.ZodOptional<T>>;
+    $lt: z.ZodOptional<z.ZodOptional<T>>;
+    $lte: z.ZodOptional<z.ZodOptional<T>>;
+    $in: z.ZodOptional<z.ZodArray<z.ZodOptional<z.ZodNullable<T>>, "many">>;
+    $nin: z.ZodOptional<z.ZodArray<z.ZodOptional<z.ZodNullable<T>>, "many">>;
+} & X> extends infer T_2 ? { [k_1 in keyof T_2]: T_2[k_1]; } : never>]>;
+export declare function queryPropertiesShape<Shape extends ZodRawShape, X extends Partial<Record<KeysOf<Shape>, Record<string, ZodTypeAny>>> = {}>(shape: Shape, extensions?: X): Record<Extract<keyof Shape, string>, z.ZodTypeAny>;
+/**
+ * Zod equivalent of @feathersjs/typebox querySyntax():
+ * - $select, $sort, $limit, $skip
+ * - field filters with operator objects ($gt/$in/...)
+ * - $and / $or (recursive)
+ *
+ * Extensions allow adding per-field custom operators (e.g. $regex for strings).
+ */
+export declare function zodQuerySyntax<Schema extends z.AnyZodObject, Shape extends Schema['shape'], X extends Partial<Record<KeysOf<Shape>, Record<string, ZodTypeAny>>> = {}>(schema: Schema, extensions?: X): z.ZodTypeAny;
+export {};

package/dist/runtime/zod/query.js

@@ -0,0 +1,75 @@
+import { z } from "zod";
+const order = z.union([z.literal(1), z.literal(-1)]);
+function coerceNumber() {
+  return z.preprocess((v) => {
+    if (typeof v === "string" && v.trim() !== "")
+      return Number(v);
+    return v;
+  }, z.number());
+}
+function coerceStringArrayFromCsv() {
+  return z.preprocess((v) => {
+    if (typeof v === "string") {
+      return v.split(",").map((s) => s.trim()).filter(Boolean);
+    }
+    return v;
+  }, z.array(z.string()));
+}
+export function sortDefinition(shape) {
+  const properties = Object.keys(shape).reduce((acc, key) => {
+    ;
+    acc[key] = order.optional();
+    return acc;
+  }, {});
+  return z.object(properties).strict();
+}
+function arrayOfKeys(shape) {
+  const keys = Object.keys(shape);
+  return z.enum(keys).array();
+}
+export function queryProperty(prop, extension = {}) {
+  const nullishProp = prop.nullish();
+  const propOptional = prop.optional();
+  return z.union([
+    // Direct equality (supports null/undefined if the base schema allows it)
+    nullishProp,
+    // Operator object
+    z.object({
+      $ne: nullishProp.optional(),
+      $gt: propOptional.optional(),
+      $gte: propOptional.optional(),
+      $lt: propOptional.optional(),
+      $lte: propOptional.optional(),
+      $in: z.array(nullishProp).optional(),
+      $nin: z.array(nullishProp).optional(),
+      ...extension
+    }).strict()
+  ]);
+}
+export function queryPropertiesShape(shape, extensions = {}) {
+  const keys = Object.keys(shape);
+  return keys.reduce((acc, key) => {
+    ;
+    acc[key] = queryProperty(shape[key], extensions[key]).optional();
+    return acc;
+  }, {});
+}
+export function zodQuerySyntax(schema, extensions = {}) {
+  const shape = schema.shape;
+  const keys = Object.keys(shape);
+  const properties = queryPropertiesShape(shape, extensions);
+  const baseQuery = z.object({
+    $select: z.union([arrayOfKeys(shape), coerceStringArrayFromCsv().pipe(z.array(z.enum(keys)))]).optional(),
+    $sort: sortDefinition(shape).optional(),
+    $limit: coerceNumber().pipe(z.number().min(-1)).optional(),
+    $skip: coerceNumber().pipe(z.number().min(0)).optional(),
+    ...properties
+  }).strict();
+  const query = z.lazy(
+    () => baseQuery.extend({
+      $or: z.array(query).optional(),
+      $and: z.array(query).optional()
+    }).strict()
+  );
+  return query;
+}

package/dist/runtime/zod/validators.d.ts

@@ -0,0 +1,17 @@
+import type { Validator } from '@feathersjs/schema';
+import type { ZodTypeAny } from 'zod';
+export type ValidatorKind = 'data' | 'query';
+export interface ZodValidatorOptions {
+    kind?: ValidatorKind;
+    message?: string;
+    useSafeParse?: boolean;
+}
+/**
+ * Feathers Schema-compatible validator based on Zod.
+ *
+ * Notes:
+ * - Accepts the extra 3rd argument (ResolverStatus) expected by @feathersjs/schema types.
+ * - Marks the validated object with VALIDATED (adapter-commons) to avoid re-validating in adapters.
+ * - Supports array data payloads (createMany).
+ */
+export declare function getZodValidator<T extends ZodTypeAny>(schema: T, opts?: ZodValidatorOptions): Validator;

package/dist/runtime/zod/validators.js

@@ -0,0 +1,46 @@
+import { VALIDATED } from "@feathersjs/adapter-commons";
+import { BadRequest } from "@feathersjs/errors";
+import { ZodError } from "zod";
+import { formatZodIssues } from "./format.js";
+export function getZodValidator(schema, opts = {}) {
+  const kind = opts.kind ?? "data";
+  const message = opts.message ?? (kind === "query" ? "Invalid query" : "Invalid data");
+  const useSafeParse = opts.useSafeParse ?? true;
+  const validator = (async (value, context, _status) => {
+    try {
+      const parseOne = async (v) => {
+        if (useSafeParse) {
+          const res = schema.safeParse(v);
+          if (!res.success) {
+            throw new BadRequest(message, {
+              errors: formatZodIssues(res.error),
+              issues: res.error.issues,
+              kind,
+              path: context?.path,
+              method: context?.method
+            });
+          }
+          return res.data;
+        }
+        return schema.parse(v);
+      };
+      const parsed = kind === "data" && Array.isArray(value) ? await Promise.all(value.map(parseOne)) : await parseOne(value);
+      Object.defineProperty(parsed, VALIDATED, { value: true });
+      return parsed;
+    } catch (err) {
+      if (err instanceof BadRequest)
+        throw err;
+      if (err instanceof ZodError) {
+        throw new BadRequest(message, {
+          errors: formatZodIssues(err),
+          issues: err.issues,
+          kind,
+          path: context?.path,
+          method: context?.method
+        });
+      }
+      throw err;
+    }
+  });
+  return validator;
+}

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.mjs'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.mjs'

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "nuxt-feathers-zod",
+  "type": "module",
+  "version": "0.1.0",
+  "packageManager": "bun@1.3.6",
+  "description": "Feathers API integration for Nuxt",
+  "author": "Herve de CHAVIGNY",
+  "license": "MIT",
+  "repository": {
+    "type": "github",
+    "url": "git+ssh://git@github.com/vevedh/nuxt-feathers-zod.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    },
+    "./options": "./dist/runtime/options/index.js",
+    "./ofetch-adapter": "./dist/runtime/adapters/ofetch.js",
+    "./validators": "./dist/runtime/zod/validators.js",
+    "./query": "./dist/runtime/zod/query.js",
+    "./format": "./dist/runtime/zod/format.js"
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": ["./dist/types.d.mts"],
+      "options": ["./dist/runtime/options/index.d.mts"],
+      "ofetch-adapter": ["./dist/runtime/adapters/ofetch.d.mts"]
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "build": "nuxi build playground",
+    "prepare": "nuxt-module-build prepare && nuxt-module-build build",
+    "lint": "eslint . && nr -r lint",
+    "lint:fix": "eslint . --fix && nr -r lint:fix",
+    "publish:npm": "bun run prepack && bun publish --access public",
+    "release": "bunx release-it",
+    "release:patch": "bunx release-it patch",
+    "release:minor": "bunx release-it minor",
+    "release:major": "bunx release-it major"
+  },
+  "peerDependencies": {
+    "nuxt": "^4.0.0"
+  },
+  "dependencies": {
+    "@feathersjs/adapter-commons": "latest",
+    "@feathersjs/authentication": "latest",
+    "@feathersjs/authentication-client": "latest",
+    "@feathersjs/authentication-local": "latest",
+    "@feathersjs/configuration": "latest",
+    "@feathersjs/errors": "^5.0.37",
+    "@feathersjs/feathers": "latest",
+    "@feathersjs/generators": "latest",
+    "@feathersjs/koa": "^5.0.37",
+    "@feathersjs/memory": "latest",
+    "@feathersjs/mongodb": "latest",
+    "@feathersjs/rest-client": "latest",
+    "@feathersjs/schema": "^5.0.37",
+    "@feathersjs/socketio-client": "latest",
+    "@gabortorma/feathers-nitro-adapter": "latest",
+    "@nuxt/kit": "latest",
+    "@pinia/nuxt": "latest",
+    "ajv-formats": "^3.0.1",
+    "change-case": "latest",
+    "consola": "latest",
+    "defu": "latest",
+    "feathers-pinia": "latest",
+    "mongodb": "^6.21.0",
+    "pinia": "latest",
+    "socket.io-client": "latest",
+    "unimport": "^3.14.6",
+    "zod": "^3.25.76"
+  },
+  "devDependencies": {
+    "@antfu/ni": "latest",
+    "@gabortorma/antfu-eslint-config": "^1.7.4",
+    "@gabortorma/mwm": "latest",
+    "@gabortorma/nuxt-eslint-layer": "latest",
+    "@nuxt/devtools": "latest",
+    "@nuxt/module-builder": "latest",
+    "@nuxt/schema": "latest",
+    "@nuxt/test-utils": "latest",
+    "@playwright/test": "latest",
+    "@types/node": "latest",
+    "dotenv-cli": "latest",
+    "eslint": "^9.39.2",
+    "nuxt": "^4.3.0",
+    "nuxt-mcp": "latest",
+    "release-it": "latest",
+    "typescript": "latest",
+    "vitest": "latest",
+    "vitest-mongodb": "latest",
+    "vue": "latest",
+    "vue-router": "latest"
+  },
+  "overrides": {
+    "@feathersjs/authentication": "5.0.37",
+    "@feathersjs/authentication-client": "5.0.37",
+    "@feathersjs/authentication-local": "5.0.37",
+    "@feathersjs/errors": "5.0.37",
+    "@feathersjs/feathers": "5.0.37",
+    "@feathersjs/koa": "5.0.37",
+    "@feathersjs/rest-client": "5.0.37",
+    "@feathersjs/schema": "5.0.37",
+    "@feathersjs/socketio-client": "5.0.37"
+  }
+}