@vibeorm/parser 1.0.0

package/src/types.ts

@@ -0,0 +1,223 @@
+/**
+ * VibeORM Intermediate Representation (IR)
+ *
+ * The parser transforms a raw prisma-ast AST into this well-typed IR,
+ * resolving relations, type mappings, constraints, and defaults.
+ */
+
+// ─── Scalar Type Mapping ──────────────────────────────────────────
+
+export type PrismaScalarType =
+  | "String"
+  | "Boolean"
+  | "Int"
+  | "BigInt"
+  | "Float"
+  | "Decimal"
+  | "DateTime"
+  | "Json"
+  | "Bytes";
+
+export type TypeScriptType =
+  | "string"
+  | "boolean"
+  | "number"
+  | "bigint"
+  | "Date"
+  | "JsonValue"
+  | "Buffer";
+
+export type PostgresType =
+  | "text"
+  | "varchar"
+  | "char"
+  | "uuid"
+  | "boolean"
+  | "integer"
+  | "bigint"
+  | "double precision"
+  | "decimal"
+  | "timestamp"
+  | "timestamptz"
+  | "jsonb"
+  | "json"
+  | "bytea"
+  | "serial"
+  | "bigserial"
+  | "smallint"
+  | "real";
+
+export const PRISMA_TO_TS: Record<PrismaScalarType, TypeScriptType> = {
+  String: "string",
+  Boolean: "boolean",
+  Int: "number",
+  BigInt: "bigint",
+  Float: "number",
+  Decimal: "string", // Decimal is represented as string for precision
+  DateTime: "Date",
+  Json: "JsonValue",
+  Bytes: "Buffer",
+};
+
+export const PRISMA_TO_PG: Record<PrismaScalarType, PostgresType> = {
+  String: "text",
+  Boolean: "boolean",
+  Int: "integer",
+  BigInt: "bigint",
+  Float: "double precision",
+  Decimal: "decimal",
+  DateTime: "timestamptz",
+  Json: "jsonb",
+  Bytes: "bytea",
+};
+
+// ─── Default Values ───────────────────────────────────────────────
+
+export type DefaultValue =
+  | { kind: "autoincrement" }
+  | { kind: "now" }
+  | { kind: "uuid" }
+  | { kind: "cuid" }
+  | { kind: "nanoid" }
+  | { kind: "ulid" }
+  | { kind: "dbgenerated"; value: string }
+  | { kind: "literal"; value: string | number | boolean };
+
+// ─── Relation Types ───────────────────────────────────────────────
+
+export type RelationType =
+  | "oneToOne"
+  | "oneToMany"
+  | "manyToOne"
+  | "manyToMany";
+
+export type RelationInfo = {
+  /** The name of the @relation("name") if specified */
+  name: string | undefined;
+  /** The field names on this model that hold the FK (e.g. ["authorId"]) */
+  fields: string[];
+  /** The field names on the related model that are referenced (e.g. ["id"]) */
+  references: string[];
+  /** The name of the related model */
+  relatedModel: string;
+  /** The resolved relation type */
+  type: RelationType;
+  /** Whether this side owns the FK (has fields/references) */
+  isForeignKey: boolean;
+};
+
+// ─── Field ────────────────────────────────────────────────────────
+
+export type ScalarField = {
+  kind: "scalar";
+  name: string;
+  /** The DB column name (from @map or defaults to name) */
+  dbName: string;
+  /** The Prisma type (String, Int, etc.) */
+  prismaType: PrismaScalarType;
+  /** The TypeScript type */
+  tsType: TypeScriptType;
+  /** The PostgreSQL column type */
+  pgType: PostgresType;
+  /** Whether the field is required (not optional) */
+  isRequired: boolean;
+  /** Whether the field is a list (PostgreSQL array) */
+  isList: boolean;
+  /** Whether this field is the @id */
+  isId: boolean;
+  /** Whether this field has @unique */
+  isUnique: boolean;
+  /** Whether this field has @updatedAt */
+  isUpdatedAt: boolean;
+  /** The @default value if present */
+  default: DefaultValue | undefined;
+  /** Native database type override (@db.VarChar(255)) */
+  nativeType: string | undefined;
+  /** Triple-slash documentation comment (///) */
+  documentation: string | undefined;
+};
+
+export type EnumField = {
+  kind: "enum";
+  name: string;
+  dbName: string;
+  /** The name of the enum type */
+  enumName: string;
+  isRequired: boolean;
+  isList: boolean;
+  isId: boolean;
+  isUnique: boolean;
+  default: DefaultValue | undefined;
+  /** Triple-slash documentation comment (///) */
+  documentation: string | undefined;
+};
+
+export type RelationField = {
+  kind: "relation";
+  name: string;
+  /** The related model name */
+  relatedModel: string;
+  /** Whether this is a list relation (Post[]) */
+  isList: boolean;
+  /** Whether the field is optional (Profile?) */
+  isRequired: boolean;
+  /** Full relation info */
+  relation: RelationInfo;
+};
+
+export type Field = ScalarField | EnumField | RelationField;
+
+// ─── Constraints ──────────────────────────────────────────────────
+
+export type PrimaryKey = {
+  fields: string[];
+  isComposite: boolean;
+};
+
+export type UniqueConstraint = {
+  fields: string[];
+  name: string | undefined;
+};
+
+export type IndexDefinition = {
+  fields: string[];
+  name: string | undefined;
+};
+
+// ─── Model ────────────────────────────────────────────────────────
+
+export type Model = {
+  name: string;
+  /** The DB table name (from @@map or defaults to name) */
+  dbName: string;
+  /** All fields including scalars, enums, and relations */
+  fields: Field[];
+  /** The primary key */
+  primaryKey: PrimaryKey;
+  /** @@unique constraints */
+  uniqueConstraints: UniqueConstraint[];
+  /** @@index definitions */
+  indexes: IndexDefinition[];
+};
+
+// ─── Enum ─────────────────────────────────────────────────────────
+
+export type EnumValue = {
+  name: string;
+  /** @map("DB_VALUE") if specified */
+  dbName: string | undefined;
+};
+
+export type Enum = {
+  name: string;
+  /** @@map("db_name") if specified */
+  dbName: string | undefined;
+  values: EnumValue[];
+};
+
+// ─── Schema (top-level IR) ────────────────────────────────────────
+
+export type Schema = {
+  models: Model[];
+  enums: Enum[];
+};