Typing

Arkorm uses your model generic and Prisma delegate shape to infer strongly typed query and attribute APIs.

Recommended pattern

Use the delegate key as the model generic and set static delegate:

import { Model } from 'arkormx'

export class User extends Model<'users'> {
  protected static override delegate = 'users'
}

Typed accessors

const user = await User.query().firstOrFail()

user.getAttribute('email')
user.setAttribute('name', 'Jane')

Typed query helpers

await User.query().whereKey('isActive', true).whereIn('id', [1, 2, 3]).get()

find supports key-safe usage:

await User.query().find(1)
await User.query().find('[email protected]', 'email')

Direct property access

Arkorm supports runtime property sugar (user.email) via proxy. For static TypeScript field completion on direct properties, sync declarations with:

npx arkorm models:sync

The generated declarations follow Prisma schema types closely:

• Prisma enums are referenced through @prisma/client type imports.
• Json fields use Record<string, unknown> | unknown[].
• Prisma list fields use Array<...>.
• If you manually narrow a generated declaration to a compatible subtype, a later sync leaves it untouched.

Untyped fallback

If you omit generics, Arkorm still works but values become loosely typed:

class AnyModel extends Model {}