Orm Auth

orm-auth

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM client for the auth API — provides typed CRUD operations for 9 tables and 28 custom operations

Usage

// Import the ORM client
import { db } from './orm';

// Available models: email, phoneNumber, cryptoAddress, webauthnCredential, auditLog, identityProvider, roleType, userConnectedAccount, ...
db.<model>.findMany({ select: { id: true } }).execute()
db.<model>.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.<model>.create({ data: { ... }, select: { id: true } }).execute()
db.<model>.update({ where: { id: '<UUID>' }, data: { ... }, select: { id: true } }).execute()
db.<model>.delete({ where: { id: '<UUID>' } }).execute()

Examples

Query records

const items = await db.email.findMany({
  select: { id: true }
}).execute();

References

See the references/ directory for detailed per-entity API documentation:

• email
• phone-number
• crypto-address
• webauthn-credential
• audit-log
• identity-provider
• role-type
• user-connected-account
• user
• current-user-agent
• current-ip-address
• current-user-id
• require-step-up
• current-user
• sign-out
• send-account-deletion-email
• check-password
• disconnect-account
• revoke-api-key
• revoke-session
• verify-password
• verify-totp
• confirm-delete-account
• set-password
• verify-email
• provision-new-user
• reset-password
• sign-in-cross-origin
• sign-up
• request-cross-origin-token
• sign-in
• extend-token-expires
• create-api-key
• forgot-password
• send-verification-email
• request-upload-url
• provision-bucket

auditLog

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Append-only audit log of authentication events (sign-in, sign-up, password changes, etc.)

Usage

db.auditLog.findMany({ select: { id: true } }).execute()
db.auditLog.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.auditLog.create({ data: { event: '<String>', actorId: '<UUID>', origin: '<Origin>', userAgent: '<String>', ipAddress: '<InternetAddress>', success: '<Boolean>' }, select: { id: true } }).execute()
db.auditLog.update({ where: { id: '<UUID>' }, data: { event: '<String>' }, select: { id: true } }).execute()
db.auditLog.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all auditLog records

const items = await db.auditLog.findMany({
  select: { id: true, event: true }
}).execute();

Create a auditLog

const item = await db.auditLog.create({
  data: { event: '<String>', actorId: '<UUID>', origin: '<Origin>', userAgent: '<String>', ipAddress: '<InternetAddress>', success: '<Boolean>' },
  select: { id: true }
}).execute();

checkPassword

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the checkPassword mutation

Usage

db.mutation.checkPassword({ input: { password: '<String>' } }).execute()

Examples

Run checkPassword

const result = await db.mutation.checkPassword({ input: { password: '<String>' } }).execute();

confirmDeleteAccount

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the confirmDeleteAccount mutation

Usage

db.mutation.confirmDeleteAccount({ input: { userId: '<UUID>', token: '<String>' } }).execute()

Examples

Run confirmDeleteAccount

const result = await db.mutation.confirmDeleteAccount({ input: { userId: '<UUID>', token: '<String>' } }).execute();

confirmUpload

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Confirm that a file has been uploaded to S3. Verifies the object exists in S3, checks content-type, and transitions the file status from 'pending' to 'ready'.

Usage

db.mutation.confirmUpload({ input: { fileId: '<UUID>' } }).execute()

Examples

Run confirmUpload

const result = await db.mutation.confirmUpload({ input: { fileId: '<UUID>' } }).execute();

connectedAccount

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

OAuth and social login connections linking external service accounts to users

Usage

db.connectedAccount.findMany({ select: { id: true } }).execute()
db.connectedAccount.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.connectedAccount.create({ data: { ownerId: '<UUID>', service: '<String>', identifier: '<String>', details: '<JSON>', isVerified: '<Boolean>' }, select: { id: true } }).execute()
db.connectedAccount.update({ where: { id: '<UUID>' }, data: { ownerId: '<UUID>' }, select: { id: true } }).execute()
db.connectedAccount.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all connectedAccount records

const items = await db.connectedAccount.findMany({
  select: { id: true, ownerId: true }
}).execute();

Create a connectedAccount

const item = await db.connectedAccount.create({
  data: { ownerId: '<UUID>', service: '<String>', identifier: '<String>', details: '<JSON>', isVerified: '<Boolean>' },
  select: { id: true }
}).execute();

createApiKey

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the createApiKey mutation

Usage

db.mutation.createApiKey({ input: { keyName: '<String>', accessLevel: '<String>', mfaLevel: '<String>', expiresIn: '<IntervalInput>' } }).execute()

Examples

Run createApiKey

const result = await db.mutation.createApiKey({ input: { keyName: '<String>', accessLevel: '<String>', mfaLevel: '<String>', expiresIn: '<IntervalInput>' } }).execute();

cryptoAddress

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Cryptocurrency wallet addresses owned by users, with network-specific validation and verification

Usage

db.cryptoAddress.findMany({ select: { id: true } }).execute()
db.cryptoAddress.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.cryptoAddress.create({ data: { ownerId: '<UUID>', address: '<String>', isVerified: '<Boolean>', isPrimary: '<Boolean>', name: '<String>' }, select: { id: true } }).execute()
db.cryptoAddress.update({ where: { id: '<UUID>' }, data: { ownerId: '<UUID>' }, select: { id: true } }).execute()
db.cryptoAddress.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all cryptoAddress records

const items = await db.cryptoAddress.findMany({
  select: { id: true, ownerId: true }
}).execute();

Create a cryptoAddress

const item = await db.cryptoAddress.create({
  data: { ownerId: '<UUID>', address: '<String>', isVerified: '<Boolean>', isPrimary: '<Boolean>', name: '<String>' },
  select: { id: true }
}).execute();

currentIpAddress

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the currentIpAddress query

Usage

db.query.currentIpAddress().execute()

Examples

Run currentIpAddress

const result = await db.query.currentIpAddress().execute();

currentUserAgent

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the currentUserAgent query

Usage

db.query.currentUserAgent().execute()

Examples

Run currentUserAgent

const result = await db.query.currentUserAgent().execute();

currentUserId

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the currentUserId query

Usage

db.query.currentUserId().execute()

Examples

Run currentUserId

const result = await db.query.currentUserId().execute();

currentUser

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the currentUser query

Usage

db.query.currentUser().execute()

Examples

Run currentUser

const result = await db.query.currentUser().execute();

disconnectAccount

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the disconnectAccount mutation

Usage

db.mutation.disconnectAccount({ input: { accountId: '<UUID>' } }).execute()

Examples

Run disconnectAccount

const result = await db.mutation.disconnectAccount({ input: { accountId: '<UUID>' } }).execute();

email

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

User email addresses with verification and primary-email management

Usage

db.email.findMany({ select: { id: true } }).execute()
db.email.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.email.create({ data: { ownerId: '<UUID>', email: '<Email>', isVerified: '<Boolean>', isPrimary: '<Boolean>', name: '<String>' }, select: { id: true } }).execute()
db.email.update({ where: { id: '<UUID>' }, data: { ownerId: '<UUID>' }, select: { id: true } }).execute()
db.email.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all email records

const items = await db.email.findMany({
  select: { id: true, ownerId: true }
}).execute();

Create a email

const item = await db.email.create({
  data: { ownerId: '<UUID>', email: '<Email>', isVerified: '<Boolean>', isPrimary: '<Boolean>', name: '<String>' },
  select: { id: true }
}).execute();

extendTokenExpires

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the extendTokenExpires mutation

Usage

db.mutation.extendTokenExpires({ input: { amount: '<IntervalInput>' } }).execute()

Examples

Run extendTokenExpires

const result = await db.mutation.extendTokenExpires({ input: { amount: '<IntervalInput>' } }).execute();

forgotPassword

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the forgotPassword mutation

Usage

db.mutation.forgotPassword({ input: { email: '<Email>' } }).execute()

Examples

Run forgotPassword

const result = await db.mutation.forgotPassword({ input: { email: '<Email>' } }).execute();

identityProvider

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM operations for IdentityProvider records

Usage

db.identityProvider.findMany({ select: { id: true } }).execute()
db.identityProvider.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.identityProvider.create({ data: { slug: '<String>', kind: '<String>', displayName: '<String>', enabled: '<Boolean>', isBuiltIn: '<Boolean>' }, select: { id: true } }).execute()
db.identityProvider.update({ where: { id: '<UUID>' }, data: { slug: '<String>' }, select: { id: true } }).execute()
db.identityProvider.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all identityProvider records

const items = await db.identityProvider.findMany({
  select: { id: true, slug: true }
}).execute();

Create a identityProvider

const item = await db.identityProvider.create({
  data: { slug: '<String>', kind: '<String>', displayName: '<String>', enabled: '<Boolean>', isBuiltIn: '<Boolean>' },
  select: { id: true }
}).execute();

oneTimeToken

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the oneTimeToken mutation

Usage

db.mutation.oneTimeToken({ input: { email: '<String>', password: '<String>', origin: '<Origin>', rememberMe: '<Boolean>' } }).execute()

Examples

Run oneTimeToken

const result = await db.mutation.oneTimeToken({ input: { email: '<String>', password: '<String>', origin: '<Origin>', rememberMe: '<Boolean>' } }).execute();

phoneNumber

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

User phone numbers with country code, verification, and primary-number management

Usage

db.phoneNumber.findMany({ select: { id: true } }).execute()
db.phoneNumber.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.phoneNumber.create({ data: { ownerId: '<UUID>', cc: '<String>', number: '<String>', isVerified: '<Boolean>', isPrimary: '<Boolean>', name: '<String>' }, select: { id: true } }).execute()
db.phoneNumber.update({ where: { id: '<UUID>' }, data: { ownerId: '<UUID>' }, select: { id: true } }).execute()
db.phoneNumber.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all phoneNumber records

const items = await db.phoneNumber.findMany({
  select: { id: true, ownerId: true }
}).execute();

Create a phoneNumber

const item = await db.phoneNumber.create({
  data: { ownerId: '<UUID>', cc: '<String>', number: '<String>', isVerified: '<Boolean>', isPrimary: '<Boolean>', name: '<String>' },
  select: { id: true }
}).execute();

provisionBucket

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Provision an S3 bucket for a logical bucket in the database. Reads the bucket config via RLS, then creates and configures the S3 bucket with the appropriate privacy policies, CORS rules, and lifecycle settings.

Usage

db.mutation.provisionBucket({ input: { bucketKey: '<String>', ownerId: '<UUID>' } }).execute()

Examples

Run provisionBucket

const result = await db.mutation.provisionBucket({ input: { bucketKey: '<String>', ownerId: '<UUID>' } }).execute();

provisionNewUser

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the provisionNewUser mutation

Usage

db.mutation.provisionNewUser({ input: { email: '<String>', password: '<String>' } }).execute()

Examples

Run provisionNewUser

const result = await db.mutation.provisionNewUser({ input: { email: '<String>', password: '<String>' } }).execute();

requestCrossOriginToken

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the requestCrossOriginToken mutation

Usage

db.mutation.requestCrossOriginToken({ input: { email: '<String>', password: '<String>', origin: '<Origin>', rememberMe: '<Boolean>' } }).execute()

Examples

Run requestCrossOriginToken

const result = await db.mutation.requestCrossOriginToken({ input: { email: '<String>', password: '<String>', origin: '<Origin>', rememberMe: '<Boolean>' } }).execute();

requestUploadUrl

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Request a presigned URL for uploading a file directly to S3. Client computes SHA-256 of the file content and provides it here. If a file with the same hash already exists (dedup), returns the existing file ID and deduplicated=true with no uploadUrl.

Usage

db.mutation.requestUploadUrl({ input: '<RequestUploadUrlInput>' }).execute()

Examples

Run requestUploadUrl

const result = await db.mutation.requestUploadUrl({ input: '<RequestUploadUrlInput>' }).execute();

requireStepUp

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the requireStepUp query

Usage

db.query.requireStepUp({ stepUpType: '<String>' }).execute()

Examples

Run requireStepUp

const result = await db.query.requireStepUp({ stepUpType: '<String>' }).execute();

resetPassword

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the resetPassword mutation

Usage

db.mutation.resetPassword({ input: { roleId: '<UUID>', resetToken: '<String>', newPassword: '<String>' } }).execute()

Examples

Run resetPassword

const result = await db.mutation.resetPassword({ input: { roleId: '<UUID>', resetToken: '<String>', newPassword: '<String>' } }).execute();

revokeApiKey

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the revokeApiKey mutation

Usage

db.mutation.revokeApiKey({ input: { keyId: '<UUID>' } }).execute()

Examples

Run revokeApiKey

const result = await db.mutation.revokeApiKey({ input: { keyId: '<UUID>' } }).execute();

revokeSession

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the revokeSession mutation

Usage

db.mutation.revokeSession({ input: { sessionId: '<UUID>' } }).execute()

Examples

Run revokeSession

const result = await db.mutation.revokeSession({ input: { sessionId: '<UUID>' } }).execute();

roleType

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM operations for RoleType records

Usage

db.roleType.findMany({ select: { id: true } }).execute()
db.roleType.findOne({ id: '<Int>', select: { id: true } }).execute()
db.roleType.create({ data: { name: '<String>' }, select: { id: true } }).execute()
db.roleType.update({ where: { id: '<Int>' }, data: { name: '<String>' }, select: { id: true } }).execute()
db.roleType.delete({ where: { id: '<Int>' } }).execute()

Examples

List all roleType records

const items = await db.roleType.findMany({
  select: { id: true, name: true }
}).execute();

Create a roleType

const item = await db.roleType.create({
  data: { name: '<String>' },
  select: { id: true }
}).execute();

sendAccountDeletionEmail

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the sendAccountDeletionEmail mutation

Usage

db.mutation.sendAccountDeletionEmail({ input: '<SendAccountDeletionEmailInput>' }).execute()

Examples

Run sendAccountDeletionEmail

const result = await db.mutation.sendAccountDeletionEmail({ input: '<SendAccountDeletionEmailInput>' }).execute();

sendVerificationEmail

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the sendVerificationEmail mutation

Usage

db.mutation.sendVerificationEmail({ input: { email: '<Email>' } }).execute()

Examples

Run sendVerificationEmail

const result = await db.mutation.sendVerificationEmail({ input: { email: '<Email>' } }).execute();

setPassword

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the setPassword mutation

Usage

db.mutation.setPassword({ input: { currentPassword: '<String>', newPassword: '<String>' } }).execute()

Examples

Run setPassword

const result = await db.mutation.setPassword({ input: { currentPassword: '<String>', newPassword: '<String>' } }).execute();

signInCrossOrigin

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the signInCrossOrigin mutation

Usage

db.mutation.signInCrossOrigin({ input: { token: '<String>', credentialKind: '<String>' } }).execute()

Examples

Run signInCrossOrigin

const result = await db.mutation.signInCrossOrigin({ input: { token: '<String>', credentialKind: '<String>' } }).execute();

signInOneTimeToken

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the signInOneTimeToken mutation

Usage

db.mutation.signInOneTimeToken({ input: { token: '<String>', credentialKind: '<String>' } }).execute()

Examples

Run signInOneTimeToken

const result = await db.mutation.signInOneTimeToken({ input: { token: '<String>', credentialKind: '<String>' } }).execute();

signIn

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the signIn mutation

Usage

db.mutation.signIn({ input: '<SignInInput>' }).execute()

Examples

Run signIn

const result = await db.mutation.signIn({ input: '<SignInInput>' }).execute();

signOut

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the signOut mutation

Usage

db.mutation.signOut({ input: '<SignOutInput>' }).execute()

Examples

Run signOut

const result = await db.mutation.signOut({ input: '<SignOutInput>' }).execute();

signUp

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the signUp mutation

Usage

db.mutation.signUp({ input: { email: '<String>', password: '<String>', rememberMe: '<Boolean>', credentialKind: '<String>', csrfToken: '<String>' } }).execute()

Examples

Run signUp

const result = await db.mutation.signUp({ input: { email: '<String>', password: '<String>', rememberMe: '<Boolean>', credentialKind: '<String>', csrfToken: '<String>' } }).execute();

userConnectedAccount

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM operations for UserConnectedAccount records

Usage

db.userConnectedAccount.findMany({ select: { id: true } }).execute()
db.userConnectedAccount.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.userConnectedAccount.create({ data: { ownerId: '<UUID>', service: '<String>', identifier: '<String>', details: '<JSON>', isVerified: '<Boolean>' }, select: { id: true } }).execute()
db.userConnectedAccount.update({ where: { id: '<UUID>' }, data: { ownerId: '<UUID>' }, select: { id: true } }).execute()
db.userConnectedAccount.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all userConnectedAccount records

const items = await db.userConnectedAccount.findMany({
  select: { id: true, ownerId: true }
}).execute();

Create a userConnectedAccount

const item = await db.userConnectedAccount.create({
  data: { ownerId: '<UUID>', service: '<String>', identifier: '<String>', details: '<JSON>', isVerified: '<Boolean>' },
  select: { id: true }
}).execute();

user

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

ORM operations for User records

Unified Search API fields: searchTsv Fields provided by the Unified Search plugin. Includes full-text search (tsvector/BM25), trigram similarity scores, and the combined searchScore. Computed fields are read-only and cannot be set in create/update operations.

Usage

db.user.findMany({ select: { id: true } }).execute()
db.user.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.user.create({ data: { username: '<String>', displayName: '<String>', profilePicture: '<Image>', searchTsv: '<FullText>', type: '<Int>', searchTsvRank: '<Float>', displayNameTrgmSimilarity: '<Float>', searchScore: '<Float>' }, select: { id: true } }).execute()
db.user.update({ where: { id: '<UUID>' }, data: { username: '<String>' }, select: { id: true } }).execute()
db.user.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all user records

const items = await db.user.findMany({
  select: { id: true, username: true }
}).execute();

Create a user

const item = await db.user.create({
  data: { username: '<String>', displayName: '<String>', profilePicture: '<Image>', searchTsv: '<FullText>', type: '<Int>', searchTsvRank: '<Float>', displayNameTrgmSimilarity: '<Float>', searchScore: '<Float>' },
  select: { id: true }
}).execute();

verifyEmail

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the verifyEmail mutation

Usage

db.mutation.verifyEmail({ input: { emailId: '<UUID>', token: '<String>' } }).execute()

Examples

Run verifyEmail

const result = await db.mutation.verifyEmail({ input: { emailId: '<UUID>', token: '<String>' } }).execute();

verifyPassword

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the verifyPassword mutation

Usage

db.mutation.verifyPassword({ input: { password: '<String>' } }).execute()

Examples

Run verifyPassword

const result = await db.mutation.verifyPassword({ input: { password: '<String>' } }).execute();

verifyTotp

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

Execute the verifyTotp mutation

Usage

db.mutation.verifyTotp({ input: { totpValue: '<String>' } }).execute()

Examples

Run verifyTotp

const result = await db.mutation.verifyTotp({ input: { totpValue: '<String>' } }).execute();

webauthnCredential

<!-- @constructive-io/graphql-codegen - DO NOT EDIT -->

WebAuthn/passkey credentials owned by users. One row per registered authenticator (security key, device biometric, synced passkey). Schema mirrors SimpleWebAuthn's canonical Passkey object.

Usage

db.webauthnCredential.findMany({ select: { id: true } }).execute()
db.webauthnCredential.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.webauthnCredential.create({ data: { ownerId: '<UUID>', credentialId: '<String>', publicKey: '<Base64EncodedBinary>', signCount: '<BigInt>', webauthnUserId: '<String>', transports: '<String>', credentialDeviceType: '<String>', backupEligible: '<Boolean>', backupState: '<Boolean>', name: '<String>', lastUsedAt: '<Datetime>' }, select: { id: true } }).execute()
db.webauthnCredential.update({ where: { id: '<UUID>' }, data: { ownerId: '<UUID>' }, select: { id: true } }).execute()
db.webauthnCredential.delete({ where: { id: '<UUID>' } }).execute()

Examples

List all webauthnCredential records

const items = await db.webauthnCredential.findMany({
  select: { id: true, ownerId: true }
}).execute();

Create a webauthnCredential

const item = await db.webauthnCredential.create({
  data: { ownerId: '<UUID>', credentialId: '<String>', publicKey: '<Base64EncodedBinary>', signCount: '<BigInt>', webauthnUserId: '<String>', transports: '<String>', credentialDeviceType: '<String>', backupEligible: '<Boolean>', backupState: '<Boolean>', name: '<String>', lastUsedAt: '<Datetime>' },
  select: { id: true }
}).execute();