drizzle-orm Architecture Docs
Home / File/ schema.types.internal.ts — drizzle-orm Source File

schema.types.internal.ts — drizzle-orm Source File

Architecture documentation for schema.types.internal.ts, a typescript file in the drizzle-orm codebase. 4 imports, 2 dependents.

File typescript ValidationAdapters TypeMapping 4 imports 2 dependents 2 functions

Entity Profile

Dependency Diagram

graph LR
  224d090d_0385_ea0a_7fbe_57b37e55038e["schema.types.internal.ts"]
  b348fe74_e713_8049_1ace_8787b971fb49["column.types.ts"]
  224d090d_0385_ea0a_7fbe_57b37e55038e --> b348fe74_e713_8049_1ace_8787b971fb49
  0dcff89a_a60f_bf80_037e_d24dd39456e3["utils.ts"]
  224d090d_0385_ea0a_7fbe_57b37e55038e --> 0dcff89a_a60f_bf80_037e_d24dd39456e3
  26760edf_9a0c_0204_77e6_f8bffa96e354["typebox"]
  224d090d_0385_ea0a_7fbe_57b37e55038e --> 26760edf_9a0c_0204_77e6_f8bffa96e354
  690f7dfc_0aea_9ee8_d6e7_26bbb3689031["drizzle-orm"]
  224d090d_0385_ea0a_7fbe_57b37e55038e --> 690f7dfc_0aea_9ee8_d6e7_26bbb3689031
  8dacc372_d6d5_e273_f9e6_3a10af9bc4a7["schema.ts"]
  8dacc372_d6d5_e273_f9e6_3a10af9bc4a7 --> 224d090d_0385_ea0a_7fbe_57b37e55038e
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb["schema.types.ts"]
  b0f80f81_d8ca_1927_f5f8_c8088fb077bb --> 224d090d_0385_ea0a_7fbe_57b37e55038e
  style 224d090d_0385_ea0a_7fbe_57b37e55038e fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import type * as t from '@sinclair/typebox';
import type { Assume, Column, DrizzleTypeError, SelectedFieldsFlat, Simplify, Table, View } from 'drizzle-orm';
import type { GetTypeboxType, HandleColumn } from './column.types.ts';
import type { ColumnIsGeneratedAlwaysAs, GetSelection } from './utils.ts';

export interface Conditions {
	never: (column?: Column) => boolean;
	optional: (column: Column) => boolean;
	nullable: (column: Column) => boolean;
}

type BuildRefineField<T> = T extends t.TSchema ? ((schema: T) => t.TSchema) | t.TSchema : never;

export type BuildRefine<
	TColumns extends Record<string, any>,
> = {
	[K in keyof TColumns as TColumns[K] extends Column | SelectedFieldsFlat<Column> | Table | View ? K : never]?:
		TColumns[K] extends Column ? BuildRefineField<GetTypeboxType<TColumns[K]>>
			: BuildRefine<GetSelection<TColumns[K]>>;
};

type HandleRefinement<
	TType extends 'select' | 'insert' | 'update',
	TRefinement,
	TColumn extends Column,
> = TRefinement extends (schema: any) => t.TSchema ? (TColumn['_']['notNull'] extends true ? ReturnType<TRefinement>
		: t.TUnion<[ReturnType<TRefinement>, t.TNull]>) extends infer TSchema
		? TType extends 'update' ? t.TOptional<Assume<TSchema, t.TSchema>> : TSchema
	: t.TSchema
	: TRefinement;

type IsRefinementDefined<
	TRefinements extends Record<string | symbol | number, any> | undefined,
	TKey extends string | symbol | number,
> = TRefinements extends object ? TRefinements[TKey] extends t.TSchema | ((schema: any) => any) ? true
	: false
	: false;

export type BuildSchema<
	TType extends 'select' | 'insert' | 'update',
	TColumns extends Record<string, any>,
	TRefinements extends Record<string, any> | undefined,
> = t.TObject<
	Simplify<
		{
			[K in keyof TColumns as ColumnIsGeneratedAlwaysAs<TColumns[K]> extends true ? never : K]: TColumns[K] extends
				infer TColumn extends Column
				? IsRefinementDefined<TRefinements, K> extends true
					? Assume<HandleRefinement<TType, TRefinements[K & keyof TRefinements], TColumn>, t.TSchema>
				: HandleColumn<TType, TColumn>
				: TColumns[K] extends infer TObject extends SelectedFieldsFlat<Column> | Table | View ? BuildSchema<
						TType,
						GetSelection<TObject>,
						TRefinements extends object ? TRefinements[K & keyof TRefinements] : undefined
					>
				: t.TAny;
		}
	>
>;

export type NoUnknownKeys<
	TRefinement extends Record<string, any>,
	TCompare extends Record<string, any>,
> = {
	[K in keyof TRefinement]: K extends keyof TCompare ? TRefinement[K] extends t.TSchema ? TRefinement[K]
		: TRefinement[K] extends Record<string, t.TSchema> ? NoUnknownKeys<TRefinement[K], TCompare[K]>
		: TRefinement[K]
		: DrizzleTypeError<`Found unknown key in refinement: "${K & string}"`>;
};

Domain

Subdomains

Functions

Types

Dependencies

Imported By

Source

Frequently Asked Questions

What does schema.types.internal.ts do?
schema.types.internal.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the ValidationAdapters domain, TypeMapping subdomain.
What functions are defined in schema.types.internal.ts?
schema.types.internal.ts defines 2 function(s): column, schema.
What does schema.types.internal.ts depend on?
schema.types.internal.ts imports 4 module(s): column.types.ts, drizzle-orm, typebox, utils.ts.
What files import schema.types.internal.ts?
schema.types.internal.ts is imported by 2 file(s): schema.ts, schema.types.ts.
Where is schema.types.internal.ts in the architecture?
schema.types.internal.ts is located at drizzle-typebox/src/schema.types.internal.ts (domain: ValidationAdapters, subdomain: TypeMapping, directory: drizzle-typebox/src).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free