joist-codegen 2.2.0 → 2.3.0-next.10

package/build/config.d.ts

@@ -1,7 +1,7 @@
-import { DbMetadata, Entity, EntityDbMetadata } from "EntityDbMetadata";
+import { DbMetadata, Entity, EntityDbMetadata } from "./EntityDbMetadata";
 import { z } from "zod";
 declare const fieldConfig: z.ZodObject<{
-    derived: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"sync">, z.ZodLiteral<"async">]>>;
+    derived: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"sync">, z.ZodLiteral<"async">]>>;
     protected: z.ZodOptional<z.ZodBoolean>;
     ignore: z.ZodOptional<z.ZodBoolean>;
     superstruct: z.ZodOptional<z.ZodString>;
@@ -12,76 +12,26 @@ declare const fieldConfig: z.ZodObject<{
     stiType: z.ZodOptional<z.ZodString>;
     notNull: z.ZodOptional<z.ZodBoolean>;
     hasDefault: z.ZodOptional<z.ZodBoolean>;
-}, "strict", z.ZodTypeAny, {
-    type?: string | undefined;
-    derived?: "sync" | "async" | undefined;
-    protected?: boolean | undefined;
-    ignore?: boolean | undefined;
-    superstruct?: string | undefined;
-    zodSchema?: string | undefined;
-    serde?: string | undefined;
-    stiDiscriminator?: Record<string, string> | undefined;
-    stiType?: string | undefined;
-    notNull?: boolean | undefined;
-    hasDefault?: boolean | undefined;
-}, {
-    type?: string | undefined;
-    derived?: "sync" | "async" | undefined;
-    protected?: boolean | undefined;
-    ignore?: boolean | undefined;
-    superstruct?: string | undefined;
-    zodSchema?: string | undefined;
-    serde?: string | undefined;
-    stiDiscriminator?: Record<string, string> | undefined;
-    stiType?: string | undefined;
-    notNull?: boolean | undefined;
-    hasDefault?: boolean | undefined;
-}>;
+}, z.core.$strict>;
 export type FieldConfig = z.infer<typeof fieldConfig>;
 declare const relationConfig: z.ZodObject<{
     derived: z.ZodOptional<z.ZodLiteral<"async">>;
-    polymorphic: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"notNull">, z.ZodLiteral<true>]>>;
+    polymorphic: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"notNull">, z.ZodLiteral<true>]>>;
     large: z.ZodOptional<z.ZodBoolean>;
     orderBy: z.ZodOptional<z.ZodString>;
+    softDeletes: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"include">, z.ZodLiteral<"exclude">]>>;
     stiType: z.ZodOptional<z.ZodString>;
-    /**
-     * Allow specializing a base type relation (SmallPublisher.group: SmallPublisherGroup).
-     *
-     * Self-referential FKs also support `subType: "self"` that means each subtype will point
-     * at its own subtype.
-     */
     subType: z.ZodOptional<z.ZodString>;
-    /** Allow skipping self-referential fields getting a `...Recursive` relation. */
     skipRecursiveRelations: z.ZodOptional<z.ZodBoolean>;
     notNull: z.ZodOptional<z.ZodBoolean>;
     hasDefault: z.ZodOptional<z.ZodBoolean>;
-}, "strict", z.ZodTypeAny, {
-    derived?: "async" | undefined;
-    stiType?: string | undefined;
-    notNull?: boolean | undefined;
-    hasDefault?: boolean | undefined;
-    polymorphic?: true | "notNull" | undefined;
-    large?: boolean | undefined;
-    orderBy?: string | undefined;
-    subType?: string | undefined;
-    skipRecursiveRelations?: boolean | undefined;
-}, {
-    derived?: "async" | undefined;
-    stiType?: string | undefined;
-    notNull?: boolean | undefined;
-    hasDefault?: boolean | undefined;
-    polymorphic?: true | "notNull" | undefined;
-    large?: boolean | undefined;
-    orderBy?: string | undefined;
-    subType?: string | undefined;
-    skipRecursiveRelations?: boolean | undefined;
-}>;
+}, z.core.$strict>;
 export type RelationConfig = z.infer<typeof relationConfig>;
 declare const entityConfig: z.ZodObject<{
     tag: z.ZodString;
     tableName: z.ZodOptional<z.ZodString>;
     fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-        derived: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"sync">, z.ZodLiteral<"async">]>>;
+        derived: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"sync">, z.ZodLiteral<"async">]>>;
         protected: z.ZodOptional<z.ZodBoolean>;
         ignore: z.ZodOptional<z.ZodBoolean>;
         superstruct: z.ZodOptional<z.ZodString>;
@@ -92,258 +42,58 @@ declare const entityConfig: z.ZodObject<{
         stiType: z.ZodOptional<z.ZodString>;
         notNull: z.ZodOptional<z.ZodBoolean>;
         hasDefault: z.ZodOptional<z.ZodBoolean>;
-    }, "strict", z.ZodTypeAny, {
-        type?: string | undefined;
-        derived?: "sync" | "async" | undefined;
-        protected?: boolean | undefined;
-        ignore?: boolean | undefined;
-        superstruct?: string | undefined;
-        zodSchema?: string | undefined;
-        serde?: string | undefined;
-        stiDiscriminator?: Record<string, string> | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-    }, {
-        type?: string | undefined;
-        derived?: "sync" | "async" | undefined;
-        protected?: boolean | undefined;
-        ignore?: boolean | undefined;
-        superstruct?: string | undefined;
-        zodSchema?: string | undefined;
-        serde?: string | undefined;
-        stiDiscriminator?: Record<string, string> | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-    }>>>;
+    }, z.core.$strict>>>;
     relations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
         derived: z.ZodOptional<z.ZodLiteral<"async">>;
-        polymorphic: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"notNull">, z.ZodLiteral<true>]>>;
+        polymorphic: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"notNull">, z.ZodLiteral<true>]>>;
         large: z.ZodOptional<z.ZodBoolean>;
         orderBy: z.ZodOptional<z.ZodString>;
+        softDeletes: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"include">, z.ZodLiteral<"exclude">]>>;
         stiType: z.ZodOptional<z.ZodString>;
-        /**
-         * Allow specializing a base type relation (SmallPublisher.group: SmallPublisherGroup).
-         *
-         * Self-referential FKs also support `subType: "self"` that means each subtype will point
-         * at its own subtype.
-         */
         subType: z.ZodOptional<z.ZodString>;
-        /** Allow skipping self-referential fields getting a `...Recursive` relation. */
         skipRecursiveRelations: z.ZodOptional<z.ZodBoolean>;
         notNull: z.ZodOptional<z.ZodBoolean>;
         hasDefault: z.ZodOptional<z.ZodBoolean>;
-    }, "strict", z.ZodTypeAny, {
-        derived?: "async" | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-        polymorphic?: true | "notNull" | undefined;
-        large?: boolean | undefined;
-        orderBy?: string | undefined;
-        subType?: string | undefined;
-        skipRecursiveRelations?: boolean | undefined;
-    }, {
-        derived?: "async" | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-        polymorphic?: true | "notNull" | undefined;
-        large?: boolean | undefined;
-        orderBy?: string | undefined;
-        subType?: string | undefined;
-        skipRecursiveRelations?: boolean | undefined;
-    }>>>;
-    /** Whether this entity should be abstract, e.g. for inheritance a subtype must be instantiated instead of this type. */
+    }, z.core.$strict>>>;
     abstract: z.ZodOptional<z.ZodBoolean>;
     orderBy: z.ZodOptional<z.ZodString>;
-    uniqueBy: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">]>, string[][], string | string[] | string[][]>>;
-}, "strict", z.ZodTypeAny, {
-    tag: string;
-    tableName?: string | undefined;
-    fields?: Record<string, {
-        type?: string | undefined;
-        derived?: "sync" | "async" | undefined;
-        protected?: boolean | undefined;
-        ignore?: boolean | undefined;
-        superstruct?: string | undefined;
-        zodSchema?: string | undefined;
-        serde?: string | undefined;
-        stiDiscriminator?: Record<string, string> | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-    }> | undefined;
-    relations?: Record<string, {
-        derived?: "async" | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-        polymorphic?: true | "notNull" | undefined;
-        large?: boolean | undefined;
-        orderBy?: string | undefined;
-        subType?: string | undefined;
-        skipRecursiveRelations?: boolean | undefined;
-    }> | undefined;
-    orderBy?: string | undefined;
-    abstract?: boolean | undefined;
-    uniqueBy?: string[][] | undefined;
-}, {
-    tag: string;
-    tableName?: string | undefined;
-    fields?: Record<string, {
-        type?: string | undefined;
-        derived?: "sync" | "async" | undefined;
-        protected?: boolean | undefined;
-        ignore?: boolean | undefined;
-        superstruct?: string | undefined;
-        zodSchema?: string | undefined;
-        serde?: string | undefined;
-        stiDiscriminator?: Record<string, string> | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-    }> | undefined;
-    relations?: Record<string, {
-        derived?: "async" | undefined;
-        stiType?: string | undefined;
-        notNull?: boolean | undefined;
-        hasDefault?: boolean | undefined;
-        polymorphic?: true | "notNull" | undefined;
-        large?: boolean | undefined;
-        orderBy?: string | undefined;
-        subType?: string | undefined;
-        skipRecursiveRelations?: boolean | undefined;
-    }> | undefined;
-    orderBy?: string | undefined;
-    abstract?: boolean | undefined;
-    uniqueBy?: string | string[] | string[][] | undefined;
-}>;
+    uniqueBy: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodArray<z.ZodString>>]>, z.ZodTransform<string[][], string | string[] | string[][]>>>;
+}, z.core.$strict>;
 export type EntityConfig = z.infer<typeof entityConfig>;
 declare const timestampConfig: z.ZodObject<{
-    /** The names to check for this timestamp, i.e. `created_at` `created`, etc. */
-    names: z.ZodArray<z.ZodString, "many">;
-    /** Whether this timestamp column is required to consider a table an entity, defaults to `false`. */
+    names: z.ZodArray<z.ZodString>;
     required: z.ZodOptional<z.ZodBoolean>;
-}, "strict", z.ZodTypeAny, {
-    names: string[];
-    required?: boolean | undefined;
-}, {
-    names: string[];
-    required?: boolean | undefined;
-}>;
+}, z.core.$strict>;
 export type TimestampConfig = z.infer<typeof timestampConfig>;
 export declare const config: z.ZodObject<{
-    /** The _build-time_ database URL for reading database metadata. */
     databaseUrl: z.ZodOptional<z.ZodString>;
-    /** Your application's request-level `Context` type. */
     contextType: z.ZodOptional<z.ZodString>;
-    /** Your application's database client's `Transaction` type. */
     transactionType: z.ZodOptional<z.ZodString>;
-    /**
-     * Allows the user to specify the `updated_at` / `created_at` column names to look up, and if they're optional.
-     *
-     * We default to looking for `updated_at`, `updatedAt`, `created_at`, `createdAt`, and optional to true,
-     * e.g. tables are not required to have both timestamp columns to be considered entities.
-     *
-     * These defaults are the most lenient, to facilitate running Joist against an existing schema and
-     * seeing all of your entities, regardless of your previous conventions.
-     */
     timestampColumns: z.ZodOptional<z.ZodObject<{
         createdAt: z.ZodOptional<z.ZodObject<{
-            /** The names to check for this timestamp, i.e. `created_at` `created`, etc. */
-            names: z.ZodArray<z.ZodString, "many">;
-            /** Whether this timestamp column is required to consider a table an entity, defaults to `false`. */
+            names: z.ZodArray<z.ZodString>;
             required: z.ZodOptional<z.ZodBoolean>;
-        }, "strict", z.ZodTypeAny, {
-            names: string[];
-            required?: boolean | undefined;
-        }, {
-            names: string[];
-            required?: boolean | undefined;
-        }>>;
+        }, z.core.$strict>>;
         updatedAt: z.ZodOptional<z.ZodObject<{
-            /** The names to check for this timestamp, i.e. `created_at` `created`, etc. */
-            names: z.ZodArray<z.ZodString, "many">;
-            /** Whether this timestamp column is required to consider a table an entity, defaults to `false`. */
+            names: z.ZodArray<z.ZodString>;
             required: z.ZodOptional<z.ZodBoolean>;
-        }, "strict", z.ZodTypeAny, {
-            names: string[];
-            required?: boolean | undefined;
-        }, {
-            names: string[];
-            required?: boolean | undefined;
-        }>>;
+        }, z.core.$strict>>;
         deletedAt: z.ZodOptional<z.ZodObject<{
-            /** The names to check for this timestamp, i.e. `created_at` `created`, etc. */
-            names: z.ZodArray<z.ZodString, "many">;
-            /** Whether this timestamp column is required to consider a table an entity, defaults to `false`. */
+            names: z.ZodArray<z.ZodString>;
             required: z.ZodOptional<z.ZodBoolean>;
-        }, "strict", z.ZodTypeAny, {
-            names: string[];
-            required?: boolean | undefined;
-        }, {
-            names: string[];
-            required?: boolean | undefined;
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        createdAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        updatedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        deletedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-    }, {
-        createdAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        updatedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        deletedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-    }>>;
-    /**
-     * Allows the user to have codegen output `Temporal` types (via `temporal-polyfill`) instead of the base JS `Date`
-     *
-     * Additionally, allows for specifying the default time zone for `Temporal` types when converting dates to/from
-     * the database.
-     */
-    temporal: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
+        }, z.core.$strict>>;
+    }, z.core.$strip>>;
+    temporal: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodObject<{
         timeZone: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        timeZone: string;
-    }, {
-        timeZone: string;
-    }>]>>;
-    /**
-     * By default, we create a `flush_database` function for fast testing.
-     *
-     * However, if you don't want to use this, or you have your own bespoke function like we do
-     * that is more application-aware, then you can disable Joist's out-of-the-box one.
-     *
-     * If you have more than one test database, you can set `createFlushFunction` to the array
-     * of test database names, i.e. `mydb_test_1`, `mydb_test_2`, etc.
-     */
-    createFlushFunction: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodArray<z.ZodString, "many">]>>;
+    }, z.core.$strip>]>>;
+    createFlushFunction: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodArray<z.ZodString>]>>;
     entitiesDirectory: z.ZodDefault<z.ZodString>;
-    codegenPlugins: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    codegenPlugins: z.ZodOptional<z.ZodArray<z.ZodString>>;
     entities: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
         tag: z.ZodString;
         tableName: z.ZodOptional<z.ZodString>;
         fields: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            derived: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"sync">, z.ZodLiteral<"async">]>>;
+            derived: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"sync">, z.ZodLiteral<"async">]>>;
             protected: z.ZodOptional<z.ZodBoolean>;
             ignore: z.ZodOptional<z.ZodBoolean>;
             superstruct: z.ZodOptional<z.ZodString>;
@@ -354,280 +104,34 @@ export declare const config: z.ZodObject<{
             stiType: z.ZodOptional<z.ZodString>;
             notNull: z.ZodOptional<z.ZodBoolean>;
             hasDefault: z.ZodOptional<z.ZodBoolean>;
-        }, "strict", z.ZodTypeAny, {
-            type?: string | undefined;
-            derived?: "sync" | "async" | undefined;
-            protected?: boolean | undefined;
-            ignore?: boolean | undefined;
-            superstruct?: string | undefined;
-            zodSchema?: string | undefined;
-            serde?: string | undefined;
-            stiDiscriminator?: Record<string, string> | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-        }, {
-            type?: string | undefined;
-            derived?: "sync" | "async" | undefined;
-            protected?: boolean | undefined;
-            ignore?: boolean | undefined;
-            superstruct?: string | undefined;
-            zodSchema?: string | undefined;
-            serde?: string | undefined;
-            stiDiscriminator?: Record<string, string> | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-        }>>>;
+        }, z.core.$strict>>>;
         relations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
             derived: z.ZodOptional<z.ZodLiteral<"async">>;
-            polymorphic: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"notNull">, z.ZodLiteral<true>]>>;
+            polymorphic: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"notNull">, z.ZodLiteral<true>]>>;
             large: z.ZodOptional<z.ZodBoolean>;
             orderBy: z.ZodOptional<z.ZodString>;
+            softDeletes: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"include">, z.ZodLiteral<"exclude">]>>;
             stiType: z.ZodOptional<z.ZodString>;
-            /**
-             * Allow specializing a base type relation (SmallPublisher.group: SmallPublisherGroup).
-             *
-             * Self-referential FKs also support `subType: "self"` that means each subtype will point
-             * at its own subtype.
-             */
             subType: z.ZodOptional<z.ZodString>;
-            /** Allow skipping self-referential fields getting a `...Recursive` relation. */
             skipRecursiveRelations: z.ZodOptional<z.ZodBoolean>;
             notNull: z.ZodOptional<z.ZodBoolean>;
             hasDefault: z.ZodOptional<z.ZodBoolean>;
-        }, "strict", z.ZodTypeAny, {
-            derived?: "async" | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-            polymorphic?: true | "notNull" | undefined;
-            large?: boolean | undefined;
-            orderBy?: string | undefined;
-            subType?: string | undefined;
-            skipRecursiveRelations?: boolean | undefined;
-        }, {
-            derived?: "async" | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-            polymorphic?: true | "notNull" | undefined;
-            large?: boolean | undefined;
-            orderBy?: string | undefined;
-            subType?: string | undefined;
-            skipRecursiveRelations?: boolean | undefined;
-        }>>>;
-        /** Whether this entity should be abstract, e.g. for inheritance a subtype must be instantiated instead of this type. */
+        }, z.core.$strict>>>;
         abstract: z.ZodOptional<z.ZodBoolean>;
         orderBy: z.ZodOptional<z.ZodString>;
-        uniqueBy: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">, z.ZodArray<z.ZodArray<z.ZodString, "many">, "many">]>, string[][], string | string[] | string[][]>>;
-    }, "strict", z.ZodTypeAny, {
-        tag: string;
-        tableName?: string | undefined;
-        fields?: Record<string, {
-            type?: string | undefined;
-            derived?: "sync" | "async" | undefined;
-            protected?: boolean | undefined;
-            ignore?: boolean | undefined;
-            superstruct?: string | undefined;
-            zodSchema?: string | undefined;
-            serde?: string | undefined;
-            stiDiscriminator?: Record<string, string> | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-        }> | undefined;
-        relations?: Record<string, {
-            derived?: "async" | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-            polymorphic?: true | "notNull" | undefined;
-            large?: boolean | undefined;
-            orderBy?: string | undefined;
-            subType?: string | undefined;
-            skipRecursiveRelations?: boolean | undefined;
-        }> | undefined;
-        orderBy?: string | undefined;
-        abstract?: boolean | undefined;
-        uniqueBy?: string[][] | undefined;
-    }, {
-        tag: string;
-        tableName?: string | undefined;
-        fields?: Record<string, {
-            type?: string | undefined;
-            derived?: "sync" | "async" | undefined;
-            protected?: boolean | undefined;
-            ignore?: boolean | undefined;
-            superstruct?: string | undefined;
-            zodSchema?: string | undefined;
-            serde?: string | undefined;
-            stiDiscriminator?: Record<string, string> | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-        }> | undefined;
-        relations?: Record<string, {
-            derived?: "async" | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-            polymorphic?: true | "notNull" | undefined;
-            large?: boolean | undefined;
-            orderBy?: string | undefined;
-            subType?: string | undefined;
-            skipRecursiveRelations?: boolean | undefined;
-        }> | undefined;
-        orderBy?: string | undefined;
-        abstract?: boolean | undefined;
-        uniqueBy?: string | string[] | string[][] | undefined;
-    }>>>;
-    ignoredTables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    /** The type of entity `id` fields; defaults to `tagged-string`. */
-    idType: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"tagged-string">, z.ZodLiteral<"untagged-string">, z.ZodLiteral<"number">]>>;
-    /** How we should support non-deferred foreign keys. */
-    nonDeferredForeignKeys: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"ignore">]>>;
-    /** Enables esm output. */
+        uniqueBy: z.ZodOptional<z.ZodPipe<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodArray<z.ZodString>>]>, z.ZodTransform<string[][], string | string[] | string[][]>>>;
+    }, z.core.$strict>>>;
+    ignoredTables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    idType: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"tagged-string">, z.ZodLiteral<"untagged-string">, z.ZodLiteral<"number">]>>;
+    nonDeferredForeignKeys: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"error">, z.ZodLiteral<"warn">, z.ZodLiteral<"ignore">]>>;
     esm: z.ZodOptional<z.ZodBoolean>;
-    /** Enables documentation syncing between .md files and JSDocs. */
+    paginationStyle: z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"cursor">, z.ZodLiteral<"limit">]>>>;
     docs: z.ZodOptional<z.ZodBoolean>;
-    /** Output a metadata-docs.ts file with entity/field documentation available at runtime. */
     outputDocs: z.ZodOptional<z.ZodBoolean>;
-    /** Auto-set by probing the project's `tsconfig.json` file. */
     allowImportingTsExtensions: z.ZodOptional<z.ZodBoolean>;
-    /** The latest Joist codemod counter that has been applied to this project. */
     codemodVersion: z.ZodDefault<z.ZodNumber>;
-    /** A list of postgres schemas to use for finding tables */
-    schemas: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strict", z.ZodTypeAny, {
-    entitiesDirectory: string;
-    entities: Record<string, {
-        tag: string;
-        tableName?: string | undefined;
-        fields?: Record<string, {
-            type?: string | undefined;
-            derived?: "sync" | "async" | undefined;
-            protected?: boolean | undefined;
-            ignore?: boolean | undefined;
-            superstruct?: string | undefined;
-            zodSchema?: string | undefined;
-            serde?: string | undefined;
-            stiDiscriminator?: Record<string, string> | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-        }> | undefined;
-        relations?: Record<string, {
-            derived?: "async" | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-            polymorphic?: true | "notNull" | undefined;
-            large?: boolean | undefined;
-            orderBy?: string | undefined;
-            subType?: string | undefined;
-            skipRecursiveRelations?: boolean | undefined;
-        }> | undefined;
-        orderBy?: string | undefined;
-        abstract?: boolean | undefined;
-        uniqueBy?: string[][] | undefined;
-    }>;
-    codemodVersion: number;
-    databaseUrl?: string | undefined;
-    contextType?: string | undefined;
-    transactionType?: string | undefined;
-    timestampColumns?: {
-        createdAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        updatedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        deletedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-    } | undefined;
-    temporal?: boolean | {
-        timeZone: string;
-    } | undefined;
-    createFlushFunction?: boolean | string[] | undefined;
-    codegenPlugins?: string[] | undefined;
-    ignoredTables?: string[] | undefined;
-    idType?: "number" | "tagged-string" | "untagged-string" | undefined;
-    nonDeferredForeignKeys?: "warn" | "error" | "ignore" | undefined;
-    esm?: boolean | undefined;
-    docs?: boolean | undefined;
-    outputDocs?: boolean | undefined;
-    allowImportingTsExtensions?: boolean | undefined;
-    schemas?: string[] | undefined;
-}, {
-    databaseUrl?: string | undefined;
-    contextType?: string | undefined;
-    transactionType?: string | undefined;
-    timestampColumns?: {
-        createdAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        updatedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-        deletedAt?: {
-            names: string[];
-            required?: boolean | undefined;
-        } | undefined;
-    } | undefined;
-    temporal?: boolean | {
-        timeZone: string;
-    } | undefined;
-    createFlushFunction?: boolean | string[] | undefined;
-    entitiesDirectory?: string | undefined;
-    codegenPlugins?: string[] | undefined;
-    entities?: Record<string, {
-        tag: string;
-        tableName?: string | undefined;
-        fields?: Record<string, {
-            type?: string | undefined;
-            derived?: "sync" | "async" | undefined;
-            protected?: boolean | undefined;
-            ignore?: boolean | undefined;
-            superstruct?: string | undefined;
-            zodSchema?: string | undefined;
-            serde?: string | undefined;
-            stiDiscriminator?: Record<string, string> | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-        }> | undefined;
-        relations?: Record<string, {
-            derived?: "async" | undefined;
-            stiType?: string | undefined;
-            notNull?: boolean | undefined;
-            hasDefault?: boolean | undefined;
-            polymorphic?: true | "notNull" | undefined;
-            large?: boolean | undefined;
-            orderBy?: string | undefined;
-            subType?: string | undefined;
-            skipRecursiveRelations?: boolean | undefined;
-        }> | undefined;
-        orderBy?: string | undefined;
-        abstract?: boolean | undefined;
-        uniqueBy?: string | string[] | string[][] | undefined;
-    }> | undefined;
-    ignoredTables?: string[] | undefined;
-    idType?: "number" | "tagged-string" | "untagged-string" | undefined;
-    nonDeferredForeignKeys?: "warn" | "error" | "ignore" | undefined;
-    esm?: boolean | undefined;
-    docs?: boolean | undefined;
-    outputDocs?: boolean | undefined;
-    allowImportingTsExtensions?: boolean | undefined;
-    codemodVersion?: number | undefined;
-    schemas?: string[] | undefined;
-}>;
+    schemas: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
 export type Config = z.infer<typeof config> & {
     __tableToEntityName?: Record<string, string>;
 };
@@ -645,6 +149,8 @@ export declare function superstructConfig(config: Config, entity: Entity, fieldN
 export declare function zodSchemaConfig(config: Config, entity: Entity, fieldName: string): string | undefined;
 export declare function fieldTypeConfig(config: Config, entity: Entity, fieldName: string): string | undefined;
 export declare function isLargeCollection(config: Config, entity: Entity, fieldName: string): boolean;
+/** Whether a collection should include (or exclude) soft-deleted entities from `.get`/`.load`. */
+export declare function softDeletesConfig(config: Config, entity: Entity, fieldName: string): "include" | "exclude" | undefined;
 export declare function isFieldIgnored(config: Config, entity: Entity, fieldName: string, notNull?: boolean, hasDefault?: boolean): boolean;
 export declare function isFieldHasDefault(config: Config, entity: Entity, fieldName: string): boolean;
 export declare function loadConfig(): Promise<Config>;