@stacksjs/orm 0.70.88 → 0.70.90

package/dist/index.d.ts

@@ -0,0 +1,232 @@
+import '@stacksjs/validation';
+export type { PrunableOptions } from './utils/prunable';
+export type { AuditHelpers } from './traits/audit';
+// Re-export soft-delete option types so user code can `satisfies SoftDeleteOptions`.
+export type { SoftDeleteOptions, SoftDeleteHelpers } from './traits/soft-deletes';
+export type { GenerateSchemaOptions, GenerateSchemaResult } from './generate-database-schema';
+export type { CursorPaginator, Paginator, SimplePaginator } from './paginator';
+export type { ResolvedPageArgs } from './paginator-request';
+// Re-export type utilities from bun-query-builder so consumers can infer
+// model types directly from defineModel() definitions
+export type {
+  InferAttributes,
+  InferPrimaryKey,
+  InferRelationNames,
+  InferTableName,
+  ModelDefinition,
+} from '@stacksjs/query-builder';
+/**
+ * Returns a Proxy that lazily forwards every property access to the
+ * loaded model in `_loaded[name]`. Returns `undefined` before the
+ * deferred load completes — callers that need the load to finish
+ * first should `await ormReady`.
+ */
+declare function lazyModel<T>(name: string): T;
+/**
+ * Resolves once all framework-default models have been loaded into the
+ * lazy-export proxies. Server bootstrap code that wants to ensure model
+ * exports are populated before serving the first request should
+ * `await ormReady` early. Per-request code doesn't need to — by the
+ * time any HTTP handler runs, the microtask queue has long drained.
+ */
+export declare const ormReady: Promise<void>;
+export declare const User: boolean;
+// Queue framework models. The CLI commands `buddy queue:status`,
+// `queue:failed`, `queue:flush`, `queue:inspect`, `queue:monitor`,
+// `queue:clear` import them as `import { Job, FailedJob } from
+// '@stacksjs/orm'`. Prefer the userland publication
+// (`app/Models/Job.ts`, dropped in by `buddy publish:model Job`) so
+// projects that customize the queue model see their version.
+//
+// Gated on the 'queue' feature flag — projects that don't run a queue
+// (most marketing sites, plain CMS apps) leave it off and skip the
+// defineModel pipeline for these two entirely. The lazyModel proxy
+// returns `undefined` for unloaded models, and the CLI queue commands
+// can check `await ormReady; if (!Job) throw …` to surface a clear
+// "run ./buddy queue:install" error.
+export declare const Job: boolean;
+export declare const FailedJob: boolean;
+export declare const Activity: boolean;
+export declare const Author: boolean;
+export declare const Campaign: boolean;
+export declare const Cart: boolean;
+export declare const CartItem: boolean;
+export declare const Category: boolean;
+export declare const Comment: boolean;
+export declare const Coupon: boolean;
+export declare const Customer: boolean;
+export declare const DeliveryRoute: boolean;
+export declare const Deployment: boolean;
+export declare const DigitalDelivery: boolean;
+export declare const Driver: boolean;
+export declare const CampaignSend: boolean;
+export declare const EmailList: boolean;
+export declare const EmailListSubscriber: boolean;
+export declare const ErrorModel: boolean;
+export declare const GiftCard: boolean;
+export declare const LicenseKey: boolean;
+export declare const Log: boolean;
+export declare const LoyaltyPoint: boolean;
+export declare const LoyaltyReward: boolean;
+export declare const Manufacturer: boolean;
+export declare const Notification: boolean;
+export declare const Order: boolean;
+export declare const OrderItem: boolean;
+export declare const Page: boolean;
+export declare const Payment: boolean;
+export declare const PaymentMethod: boolean;
+export declare const PaymentProduct: boolean;
+export declare const PaymentTransaction: boolean;
+export declare const Post: boolean;
+export declare const PrintDevice: boolean;
+export declare const Product: boolean;
+export declare const ProductUnit: boolean;
+export declare const ProductVariant: boolean;
+export declare const Receipt: boolean;
+export declare const Release: boolean;
+export declare const Request: boolean;
+export declare const Review: boolean;
+export declare const ShippingMethod: boolean;
+export declare const ShippingRate: boolean;
+export declare const ShippingZone: boolean;
+export declare const SocialPost: boolean;
+export declare const Subscriber: boolean;
+export declare const SubscriberEmail: boolean;
+export declare const Subscription: boolean;
+export declare const Tag: boolean;
+export declare const TaxRate: boolean;
+export declare const Team: boolean;
+export declare const Transaction: boolean;
+export declare const WaitlistProduct: boolean;
+export declare const WaitlistRestaurant: boolean;
+export declare const Websocket: boolean;
+/**
+ * Framework-default User row shape. Matches the attributes declared on
+ * `storage/framework/defaults/app/Models/User.ts` plus the system
+ * fields contributed by `useUuid` / `useTimestamps` / `useAuth` traits.
+ *
+ * For project-specific narrowing, prefer `ModelRow<typeof User>` so
+ * any added attributes flow through automatically.
+ */
+export declare interface UserModel {
+  id: number
+  uuid: string
+  name: string
+  email: string
+  password: string
+  avatar?: string | null
+  email_verified_at?: string | null
+  two_factor_secret?: string | null
+  public_key?: string | null
+  created_at: string
+  updated_at: string | null
+  stripe_id?: string | null
+  two_factor_enabled?: boolean
+  hasStripeId: () => boolean
+  hasRole: (role: string) => boolean | Promise<boolean>
+  assignRole: (role: string) => unknown | Promise<unknown>
+  update: (data: Record<string, unknown>) => Promise<UserModel>
+  [key: string]: unknown
+}
+/**
+ * Framework-default insertable User shape — fillable attributes from
+ * the default User model, all optional (DB-side defaults can fill in
+ * the rest). For project-specific narrowing, prefer
+ * `NewModelData<typeof User>`.
+ */
+export declare interface NewUser {
+  name?: string
+  email?: string
+  password?: string
+  avatar?: string | null
+  [key: string]: unknown
+}
+/** Row type for the polymorphic categories table (categorizable trait). */
+export declare interface CategorizableTable {
+  id?: number
+  name: string
+  slug: string
+  description?: string
+  is_active: boolean
+  categorizable_type: string
+  created_at?: string
+  updated_at?: string
+}
+/** Row type for the category-model pivot table (categorizable trait). */
+export declare interface CategorizableModelsTable {
+  id?: number
+  category_id: number
+  categorizable_type: string
+  categorizable_id: number
+  created_at?: string
+  updated_at?: string
+}
+/** Row type for the polymorphic comments table (commentable trait). */
+export declare interface CommentablesTable {
+  id?: number
+  title: string
+  body: string
+  status: string
+  approved_at: number | null
+  rejected_at: number | null
+  commentables_id: number
+  commentables_type: string
+  user_id: number | null
+  created_at?: string
+  updated_at?: string | null
+}
+/** Row type for the polymorphic tags table (taggable trait). */
+export declare interface TaggableTable {
+  id?: number
+  name: string
+  slug: string
+  description?: string
+  is_active: boolean
+  taggable_type: string
+  created_at?: string
+  updated_at?: string
+}
+export * from './utils/prunable';
+export {
+  collectEncryptedAttributes,
+  decryptValue,
+  encryptValue,
+  isEncrypted,
+} from './utils/encrypted';
+// Audit trait public API: setAuditUser is the queue/cron escape hatch for
+// attributing audit rows to a user when there's no current HTTP request.
+export { setAuditUser, createAuditMethods } from './traits/audit';
+// Shared write-error classifiers (stacksjs/stacks#1957). Named exports only —
+// `export *` would collide with the snakeCase helpers also exported from
+// './auto-crud' via other barrels. `isUniqueViolation` is re-exported by
+// `@stacksjs/auth`'s './rbac-store-bqb' for back-compat; `mapWriteError`
+// powers the auto-CRUD store/update 409 mapping.
+export { isUniqueViolation, mapWriteError } from './auto-crud';
+export * from './batch-loader';
+export * from './db';
+export * from './subquery';
+export * from './transaction';
+export * from './model-types';
+export * from './types';
+export * from './utils';
+export * from './define-model';
+// Codegen for `database/types.d.ts` — augments
+// `@stacksjs/database`'s `DatabaseSchema` so `db.selectFrom(...)` gets
+// table-name autocomplete (stacksjs/stacks#1923).
+export { buildDatabaseSchema, renderDatabaseTypeFile } from './generate-database-schema';
+// Canonical paginator shapes + adapters (stacksjs/stacks#1905 P1).
+export {
+  isCursorPaginator,
+  isPaginator,
+  isSimplePaginator,
+  toCursorPaginator,
+  toPaginator,
+  toSimplePaginator,
+} from './paginator';
+// Request-aware pagination helpers (stacksjs/stacks#1906 P2 + #1907 P3).
+export {
+  enrichPaginatorUrls,
+  parseCursor,
+  resolveCursorArgs,
+  resolvePageArgs,
+} from './paginator-request';