fauna-x-schemas
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

fauna-x-schemas

This package can be used to apply validation to Fauna's new driver since they are moving away from GraphQL, it is now impossible to use the current codegen tooling.

Example usage

import z from 'zod';
import { Client, fql } from 'fauna';
import { documentSchemaFactory } from 'fauna-x-schemas';

// it is also possible to omit the collection name in which case zod will not check the collection type itself
const userSchema = documentSchemaFactory('User').merge(z.object({
  username: z.string()
}));

const client = new Client({
  secret: '',
});

// you can use the schema for validation or just for typing
const forceTyping = await client.query<z.infer<typeof userSchema>>(fql`User.byId("id")`);
const validated = userSchema.parse(
  await client.query(fql`User.byId("id")`)
);

Readme

Keywords

none

Package Sidebar

Install

npm i fauna-x-schemas

Weekly Downloads

1

Version

2.1.0

License

MIT

Unpacked Size

9.95 kB

Total Files

30

Last publish

Collaborators

  • liammartens