drizzle-valibot 0.0.1 → 0.1.0

package/README.md

@@ -0,0 +1,42 @@
+`drizzle-valibot` is a plugin for [Drizzle ORM](https://github.com/drizzle-team/drizzle-orm) that allows you to generate [valibot](https://valibot.dev/) schemas from Drizzle ORM schemas.
+
+# Usage
+
+```ts
+import { pgEnum, pgTable, serial, text, timestamp } from 'drizzle-orm/pg-core';
+import { createInsertSchema, createSelectSchema } from 'drizzle-valibot';
+import { string, parse, number } from 'valibot';
+
+const users = pgTable('users', {
+	id: serial('id').primaryKey(),
+	name: text('name').notNull(),
+	email: text('email').notNull(),
+	role: text('role', { enum: ['admin', 'user'] }).notNull(),
+	createdAt: timestamp('created_at').notNull().defaultNow(),
+});
+
+// Schema for inserting a user - can be used to validate API requests
+const insertUserSchema = createInsertSchema(users);
+
+// Schema for selecting a user - can be used to validate API responses
+const selectUserSchema = createSelectSchema(users);
+
+// Overriding the fields
+const insertUserSchema = createInsertSchema(users, {
+	role: string,
+});
+
+// Refining the fields - useful if you want to change the fields before they become nullable/optional in the final schema
+const insertUserSchema = createInsertSchema(users, {
+	id: (schema) => number([minValue(0)]),
+	role: string(),
+});
+
+// Usage
+
+const isUserValid = parse(insertUserSchema, {
+	name: 'John Doe',
+	email: 'johndoe@test.com',
+	role: 'admin',
+});
+```

package/index.cjs

@@ -0,0 +1,2 @@
+"use strict";var e=require("drizzle-orm"),t=require("drizzle-orm/mysql-core"),r=require("drizzle-orm/pg-core"),n=require("drizzle-orm/sqlite-core"),a=require("valibot");const i=a.union([a.string(),a.number(),a.boolean(),a.nullType()]),s=a.union([i,a.array(a.any()),a.record(a.any())]);function o(i){let l;if(function(e){return"enumValues"in e&&Array.isArray(e.enumValues)&&e.enumValues.length>0}(i)&&(l=i.enumValues?.length?a.enumType(i.enumValues):a.string()),!l)if("custom"===i.dataType)l=a.any();else if("json"===i.dataType)l=s;else if("array"===i.dataType)l=a.array(o(i.baseColumn));else if("number"===i.dataType)l=a.number();else if("bigint"===i.dataType)l=a.bigint();else if("boolean"===i.dataType)l=a.boolean();else if("date"===i.dataType)l=a.date();else if("string"===i.dataType){let s=a.string();(e.is(i,r.PgChar)||e.is(i,r.PgVarchar)||e.is(i,t.MySqlVarChar)||e.is(i,t.MySqlVarBinary)||e.is(i,t.MySqlChar)||e.is(i,n.SQLiteText))&&"number"==typeof i.length&&(s=a.string([a.maxLength(i.length)])),l=s}else e.is(i,r.PgUUID)&&(l=a.string([a.uuid()]));return l||(l=a.any()),l}exports.createInsertSchema=function(t,r){const n=e.getTableColumns(t),i=Object.entries(n);let s=Object.fromEntries(i.map((([e,t])=>[e,o(t)])));r&&(s=Object.assign(s,Object.fromEntries(Object.entries(r).map((([e,t])=>[e,"function"==typeof t?t(s):t])))));for(const[e,t]of i)t.notNull?t.hasDefault&&(s[e]=a.optional(s[e])):s[e]=a.optional(a.nullable(s[e]));return a.object(s)},exports.createSelectSchema=function(t,r){const n=e.getTableColumns(t),i=Object.entries(n);let s=Object.fromEntries(i.map((([e,t])=>[e,o(t)])));r&&(s=Object.assign(s,Object.fromEntries(Object.entries(r).map((([e,t])=>[e,"function"==typeof t?t(s):t])))));for(const[e,t]of i)t.notNull||(s[e]=a.nullable(s[e]));return a.object(s)},exports.jsonSchema=s;
+//# sourceMappingURL=index.cjs.map

package/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":[null],"names":["literalSchema","union","string","number","boolean","nullType","jsonSchema","array","any","record","mapColumnToSchema","column","type","Array","isArray","enumValues","length","isWithEnum","enumType","dataType","baseColumn","bigint","date","sType","is","PgChar","PgVarchar","MySqlVarChar","MySqlVarBinary","MySqlChar","SQLiteText","maxLength","PgUUID","uuid","table","refine","columns","getTableColumns","columnEntries","Object","entries","schemaEntries","fromEntries","map","name","assign","refineColumn","notNull","hasDefault","optional","nullable","object"],"mappings":"yKAkDA,MAAMA,EAAgBC,EAAAA,MAAM,CAACC,EAAAA,SAAUC,EAAAA,SAAUC,YAAWC,eAI/CC,EAAaL,EAAAA,MAAM,CAACD,EAAeO,EAAKA,MAACC,SAAQC,EAAMA,OAACD,WA2PrE,SAASE,EAAkBC,GAC1B,IAAIC,EAQJ,GAnBD,SACCD,GAEA,MACC,eAAgBA,GAChBE,MAAMC,QAAQH,EAAOI,aACrBJ,EAAOI,WAAWC,OAAS,CAE7B,CAKKC,CAAWN,KACdC,EAAOD,EAAOI,YAAYC,OACvBE,EAAQA,SAACP,EAAOI,YAChBb,EAAAA,WAGCU,EACJ,GAAwB,WAApBD,EAAOQ,SACVP,EAAOJ,EAAGA,WACJ,GAAwB,SAApBG,EAAOQ,SACjBP,EAAON,OACD,GAAwB,UAApBK,EAAOQ,SACjBP,EAAOL,EAAAA,MACNG,EAAmBC,EAA6BS,kBAE3C,GAAwB,WAApBT,EAAOQ,SACjBP,EAAOT,EAAMA,cACP,GAAwB,WAApBQ,EAAOQ,SACjBP,EAAOS,EAAMA,cACP,GAAwB,YAApBV,EAAOQ,SACjBP,EAAOR,EAAOA,eACR,GAAwB,SAApBO,EAAOQ,SACjBP,EAAOU,EAAIA,YACL,GAAwB,WAApBX,EAAOQ,SAAuB,CACxC,IAAII,EAAQrB,EAAAA,UAGVsB,EAAAA,GAAGb,EAAQc,WACXD,EAAEA,GAACb,EAAQe,cACXF,EAAEA,GAACb,EAAQgB,iBACXH,EAAEA,GAACb,EAAQiB,mBACXJ,EAAEA,GAACb,EAAQkB,cACXL,EAAEA,GAACb,EAAQmB,gBACa,iBAAlBnB,EAAOK,SAEdO,EAAQrB,EAAMA,OAAC,CAAC6B,EAAAA,UAAUpB,EAAOK,WAGlCJ,EAAOW,CACP,MAAUC,EAAEA,GAACb,EAAQqB,EAAAA,UACrBpB,EAAOV,EAAMA,OAAC,CAAC+B,EAAIA,UAQrB,OAJKrB,IACJA,EAAOJ,EAAGA,OAGJI,CACR,4BAzLM,SAILsB,EAIAC,GAaA,MAAMC,EAAUC,kBAAgBH,GAC1BI,EAAgBC,OAAOC,QAAQJ,GAErC,IAAIK,EAAgBF,OAAOG,YAC1BJ,EAAcK,KAAI,EAAEC,EAAMjC,KAClB,CAACiC,EAAMlC,EAAkBC,OAI9BwB,IACHM,EAAgBF,OAAOM,OACtBJ,EACAF,OAAOG,YACNH,OAAOC,QAAQL,GAAQQ,KAAI,EAAEC,EAAME,KAC3B,CACNF,EACwB,mBAAjBE,EACJA,EACAL,GAMAK,QAOR,IAAK,MAAOF,EAAMjC,KAAW2B,EACvB3B,EAAOoC,QAEDpC,EAAOqC,aACjBP,EAAcG,GAAQK,EAAAA,SAASR,EAAcG,KAF7CH,EAAcG,GAAQK,EAAQA,SAACC,EAAQA,SAACT,EAAcG,KAMxD,OAAOO,EAAAA,OAAOV,EACf,6BAEM,SAILP,EAIAC,GAYA,MAAMC,EAAUC,kBAAgBH,GAC1BI,EAAgBC,OAAOC,QAAQJ,GAErC,IAAIK,EAAgBF,OAAOG,YAC1BJ,EAAcK,KAAI,EAAEC,EAAMjC,KAClB,CAACiC,EAAMlC,EAAkBC,OAI9BwB,IACHM,EAAgBF,OAAOM,OACtBJ,EACAF,OAAOG,YACNH,OAAOC,QAAQL,GAAQQ,KAAI,EAAEC,EAAME,KAC3B,CACNF,EACwB,mBAAjBE,EACJA,EACAL,GAMAK,QAOR,IAAK,MAAOF,EAAMjC,KAAW2B,EACvB3B,EAAOoC,UACXN,EAAcG,GAAQM,EAAAA,SAAST,EAAcG,KAI/C,OAAOO,EAAAA,OAAOV,EACf"}

package/index.d.ts

@@ -0,0 +1,43 @@
+import { type Assume, type DrizzleTypeError, type Equal, type Simplify, type Table, type Column } from 'drizzle-orm';
+import { type AnySchema, type ArraySchema, type BaseSchema, type BigintSchema, type BooleanSchema, type DateSchema, type EnumSchema, type NullableSchema, type NumberSchema, type ObjectSchema, type OptionalSchema, type StringSchema } from 'valibot';
+type Json = typeof jsonSchema;
+export declare const jsonSchema: import("valibot").UnionSchema<[import("valibot").UnionSchema<[StringSchema<string>, NumberSchema<number>, BooleanSchema<boolean>, import("valibot").NullSchema<null>], string | number | boolean | null>, ArraySchema<AnySchema<any>, any[]>, import("valibot").RecordSchema<AnySchema<any>, StringSchema<string>, {
+    [x: string]: any;
+}>], string | number | boolean | any[] | {
+    [x: string]: any;
+} | null>;
+type MapInsertColumnToValibot<TColumn extends Column, TType extends BaseSchema<any, any>> = TColumn['_']['notNull'] extends false ? OptionalSchema<NullableSchema<TType>> : TColumn['_']['hasDefault'] extends true ? OptionalSchema<TType> : TType;
+type MapSelectColumnToValibot<TColumn extends Column, TType extends BaseSchema<any, any>> = TColumn['_']['notNull'] extends false ? NullableSchema<TType> : TType;
+type MapColumnToValibot<TColumn extends Column, TType extends BaseSchema<any, any>, TMode extends 'insert' | 'select'> = TMode extends 'insert' ? MapInsertColumnToValibot<TColumn, TType> : MapSelectColumnToValibot<TColumn, TType>;
+type MaybeOptional<TColumn extends Column, TType extends BaseSchema<any, any>, TMode extends 'insert' | 'select', TNoOptional extends boolean> = TNoOptional extends true ? TType : MapColumnToValibot<TColumn, TType, TMode>;
+type GetValibotType<TColumn extends Column> = TColumn['_']['dataType'] extends infer TDataType ? TDataType extends 'custom' ? AnySchema : TDataType extends 'json' ? Json : TColumn extends {
+    enumValues: [string, ...string[]];
+} ? Equal<TColumn['enumValues'], [string, ...string[]]> extends true ? StringSchema : EnumSchema<TColumn['enumValues'], TColumn['enumValues'][number]> : TDataType extends 'array' ? ArraySchema<GetValibotType<Assume<TColumn['_'], {
+    baseColumn: Column;
+}>['baseColumn']>> : TDataType extends 'bigint' ? BigintSchema : TDataType extends 'number' ? NumberSchema : TDataType extends 'string' ? StringSchema : TDataType extends 'boolean' ? BooleanSchema : TDataType extends 'date' ? DateSchema : AnySchema : never;
+type ValueOrUpdater<T, TUpdaterArg> = T | ((arg: TUpdaterArg) => T);
+type UnwrapValueOrUpdater<T> = T extends ValueOrUpdater<infer U, any> ? U : never;
+export type Refine<TTable extends Table, TMode extends 'select' | 'insert'> = {
+    [K in keyof TTable['_']['columns']]?: ValueOrUpdater<BaseSchema<any, any>, TMode extends 'select' ? BuildSelectSchema<TTable, {}, true> : BuildInsertSchema<TTable, {}, true>>;
+};
+export type BuildInsertSchema<TTable extends Table, TRefine extends Refine<TTable, 'insert'> | {}, TNoOptional extends boolean = false> = TTable['_']['columns'] extends infer TColumns extends Record<string, Column<any>> ? {
+    [K in keyof TColumns & string]: MaybeOptional<TColumns[K], K extends keyof TRefine ? Assume<UnwrapValueOrUpdater<TRefine[K]>, BaseSchema<any>> : GetValibotType<TColumns[K]>, 'insert', TNoOptional>;
+} : never;
+export type BuildSelectSchema<TTable extends Table, TRefine extends Refine<TTable, 'select'>, TNoOptional extends boolean = false> = Simplify<{
+    [K in keyof TTable['_']['columns']]: MaybeOptional<TTable['_']['columns'][K], K extends keyof TRefine ? Assume<UnwrapValueOrUpdater<TRefine[K]>, BaseSchema<any, any>> : GetValibotType<TTable['_']['columns'][K]>, 'select', TNoOptional>;
+}>;
+export declare function createInsertSchema<TTable extends Table, TRefine extends Refine<TTable, 'insert'> = Refine<TTable, 'insert'>>(table: TTable, 
+/**
+ * @param refine Refine schema fields
+ */
+refine?: {
+    [K in keyof TRefine]: K extends keyof TTable['_']['columns'] ? TRefine[K] : DrizzleTypeError<`Column '${K & string}' does not exist in table '${TTable['_']['name']}'`>;
+}): ObjectSchema<BuildInsertSchema<TTable, Equal<TRefine, Refine<TTable, 'insert'>> extends true ? {} : TRefine>>;
+export declare function createSelectSchema<TTable extends Table, TRefine extends Refine<TTable, 'select'> = Refine<TTable, 'select'>>(table: TTable, 
+/**
+ * @param refine Refine schema fields
+ */
+refine?: {
+    [K in keyof TRefine]: K extends keyof TTable['_']['columns'] ? TRefine[K] : DrizzleTypeError<`Column '${K & string}' does not exist in table '${TTable['_']['name']}'`>;
+}): ObjectSchema<BuildSelectSchema<TTable, Equal<TRefine, Refine<TTable, 'select'>> extends true ? {} : TRefine>>;
+export {};

package/index.mjs

@@ -0,0 +1,2 @@
+import{getTableColumns as e,is as t}from"drizzle-orm";import{MySqlVarChar as r,MySqlVarBinary as n,MySqlChar as o}from"drizzle-orm/mysql-core";import{PgChar as i,PgVarchar as s,PgUUID as a}from"drizzle-orm/pg-core";import{SQLiteText as l}from"drizzle-orm/sqlite-core";import{union as f,string as m,number as u,boolean as c,nullType as p,array as b,any as y,record as d,optional as j,nullable as O,object as g,enumType as z,bigint as T,date as h,maxLength as V,uuid as E}from"valibot";const q=f([m(),u(),c(),p()]),A=f([q,b(y()),d(y())]);function N(t,r){const n=e(t),o=Object.entries(n);let i=Object.fromEntries(o.map((([e,t])=>[e,x(t)])));r&&(i=Object.assign(i,Object.fromEntries(Object.entries(r).map((([e,t])=>[e,"function"==typeof t?t(i):t])))));for(const[e,t]of o)t.notNull?t.hasDefault&&(i[e]=j(i[e])):i[e]=j(O(i[e]));return g(i)}function v(t,r){const n=e(t),o=Object.entries(n);let i=Object.fromEntries(o.map((([e,t])=>[e,x(t)])));r&&(i=Object.assign(i,Object.fromEntries(Object.entries(r).map((([e,t])=>[e,"function"==typeof t?t(i):t])))));for(const[e,t]of o)t.notNull||(i[e]=O(i[e]));return g(i)}function x(e){let f;if(function(e){return"enumValues"in e&&Array.isArray(e.enumValues)&&e.enumValues.length>0}(e)&&(f=e.enumValues?.length?z(e.enumValues):m()),!f)if("custom"===e.dataType)f=y();else if("json"===e.dataType)f=A;else if("array"===e.dataType)f=b(x(e.baseColumn));else if("number"===e.dataType)f=u();else if("bigint"===e.dataType)f=T();else if("boolean"===e.dataType)f=c();else if("date"===e.dataType)f=h();else if("string"===e.dataType){let a=m();(t(e,i)||t(e,s)||t(e,r)||t(e,n)||t(e,o)||t(e,l))&&"number"==typeof e.length&&(a=m([V(e.length)])),f=a}else t(e,a)&&(f=m([E()]));return f||(f=y()),f}export{N as createInsertSchema,v as createSelectSchema,A as jsonSchema};
+//# sourceMappingURL=index.mjs.map

package/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../src/index.ts"],"sourcesContent":[null],"names":["literalSchema","union","string","number","boolean","nullType","jsonSchema","array","any","record","createInsertSchema","table","refine","columns","getTableColumns","columnEntries","Object","entries","schemaEntries","fromEntries","map","name","column","mapColumnToSchema","assign","refineColumn","notNull","hasDefault","optional","nullable","object","createSelectSchema","type","Array","isArray","enumValues","length","isWithEnum","enumType","dataType","baseColumn","bigint","date","sType","is","PgChar","PgVarchar","MySqlVarChar","MySqlVarBinary","MySqlChar","SQLiteText","maxLength","PgUUID","uuid"],"mappings":"oeAkDA,MAAMA,EAAgBC,EAAM,CAACC,IAAUC,IAAUC,IAAWC,MAI/CC,EAAaL,EAAM,CAACD,EAAeO,EAAMC,KAAQC,EAAOD,OAsH/D,SAAUE,EAIfC,EAIAC,GAaA,MAAMC,EAAUC,EAAgBH,GAC1BI,EAAgBC,OAAOC,QAAQJ,GAErC,IAAIK,EAAgBF,OAAOG,YAC1BJ,EAAcK,KAAI,EAAEC,EAAMC,KAClB,CAACD,EAAME,EAAkBD,OAI9BV,IACHM,EAAgBF,OAAOQ,OACtBN,EACAF,OAAOG,YACNH,OAAOC,QAAQL,GAAQQ,KAAI,EAAEC,EAAMI,KAC3B,CACNJ,EACwB,mBAAjBI,EACJA,EACAP,GAMAO,QAOR,IAAK,MAAOJ,EAAMC,KAAWP,EACvBO,EAAOI,QAEDJ,EAAOK,aACjBT,EAAcG,GAAQO,EAASV,EAAcG,KAF7CH,EAAcG,GAAQO,EAASC,EAASX,EAAcG,KAMxD,OAAOS,EAAOZ,EACf,CAEM,SAAUa,EAIfpB,EAIAC,GAYA,MAAMC,EAAUC,EAAgBH,GAC1BI,EAAgBC,OAAOC,QAAQJ,GAErC,IAAIK,EAAgBF,OAAOG,YAC1BJ,EAAcK,KAAI,EAAEC,EAAMC,KAClB,CAACD,EAAME,EAAkBD,OAI9BV,IACHM,EAAgBF,OAAOQ,OACtBN,EACAF,OAAOG,YACNH,OAAOC,QAAQL,GAAQQ,KAAI,EAAEC,EAAMI,KAC3B,CACNJ,EACwB,mBAAjBI,EACJA,EACAP,GAMAO,QAOR,IAAK,MAAOJ,EAAMC,KAAWP,EACvBO,EAAOI,UACXR,EAAcG,GAAQQ,EAASX,EAAcG,KAI/C,OAAOS,EAAOZ,EACf,CAYA,SAASK,EAAkBD,GAC1B,IAAIU,EAQJ,GAnBD,SACCV,GAEA,MACC,eAAgBA,GAChBW,MAAMC,QAAQZ,EAAOa,aACrBb,EAAOa,WAAWC,OAAS,CAE7B,CAKKC,CAAWf,KACdU,EAAOV,EAAOa,YAAYC,OACvBE,EAAShB,EAAOa,YAChBjC,MAGC8B,EACJ,GAAwB,WAApBV,EAAOiB,SACVP,EAAOxB,SACD,GAAwB,SAApBc,EAAOiB,SACjBP,EAAO1B,OACD,GAAwB,UAApBgB,EAAOiB,SACjBP,EAAOzB,EACNgB,EAAmBD,EAA6BkB,kBAE3C,GAAwB,WAApBlB,EAAOiB,SACjBP,EAAO7B,SACD,GAAwB,WAApBmB,EAAOiB,SACjBP,EAAOS,SACD,GAAwB,YAApBnB,EAAOiB,SACjBP,EAAO5B,SACD,GAAwB,SAApBkB,EAAOiB,SACjBP,EAAOU,SACD,GAAwB,WAApBpB,EAAOiB,SAAuB,CACxC,IAAII,EAAQzC,KAGV0C,EAAGtB,EAAQuB,IACXD,EAAGtB,EAAQwB,IACXF,EAAGtB,EAAQyB,IACXH,EAAGtB,EAAQ0B,IACXJ,EAAGtB,EAAQ2B,IACXL,EAAGtB,EAAQ4B,KACa,iBAAlB5B,EAAOc,SAEdO,EAAQzC,EAAO,CAACiD,EAAU7B,EAAOc,WAGlCJ,EAAOW,CACP,MAAUC,EAAGtB,EAAQ8B,KACrBpB,EAAO9B,EAAO,CAACmD,OAQjB,OAJKrB,IACJA,EAAOxB,KAGDwB,CACR"}

package/package.json

@@ -1,11 +1,78 @@
 {
   "name": "drizzle-valibot",
-  "version": "0.0.1",
-  "description": "",
-  "main": "index.js",
+  "version": "0.1.0",
+  "description": "Generate valibot schemas from Drizzle ORM schemas",
+  "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "rimraf dist && rollup --config rollup.config.ts --configPlugin typescript && resolve-tspaths && cp README.md package.json dist/",
+    "b": "pnpm build",
+    "test:types": "cd tests && tsc",
+    "pack": "(cd dist && npm pack --pack-destination ..) && rm -f package.tgz && mv *.tgz package.tgz",
+    "publish": "npm publish package.tgz",
+    "test": "ava tests"
   },
-  "author": "",
-  "license": "ISC"
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.mjs",
+      "require": "./index.cjs",
+      "default": "./index.mjs"
+    }
+  },
+  "main": "./index.cjs",
+  "module": "./index.mjs",
+  "types": "./index.d.ts",
+  "publishConfig": {
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/drizzle-team/drizzle-orm.git"
+  },
+  "ava": {
+    "files": [
+      "tests/**/*.test.ts",
+      "!tests/bun/**/*"
+    ],
+    "extensions": {
+      "ts": "module"
+    },
+    "nodeArguments": [
+      "--loader=tsx"
+    ]
+  },
+  "keywords": [
+    "valibot",
+    "validate",
+    "validation",
+    "schema",
+    "drizzle",
+    "orm",
+    "pg",
+    "mysql",
+    "postgresql",
+    "postgres",
+    "sqlite",
+    "database",
+    "sql",
+    "typescript",
+    "ts"
+  ],
+  "author": "Drizzle Team",
+  "license": "Apache-2.0",
+  "peerDependencies": {
+    "drizzle-orm": ">=0.23.13"
+  },
+  "devDependencies": {
+    "@rollup/plugin-terser": "^0.4.1",
+    "@rollup/plugin-typescript": "^11.1.0",
+    "@sinclair/typebox": "^0.29.6",
+    "@types/node": "^18.15.10",
+    "ava": "^5.1.0",
+    "drizzle-orm": "link:../drizzle-orm/dist",
+    "rimraf": "^5.0.0",
+    "rollup": "^3.20.7",
+    "tsx": "^3.12.2",
+    "valibot": "^0.12.0"
+  }
 }