orchid-orm 1.78.1 → 1.78.2

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Adapter, AfterCommitStandaloneHook, AfterHook, BrandColumnsShape, Column, ColumnSchemaConfig, ColumnsShape, ComputedOptionsConfig, ComputedOptionsFactory, CreateData, CreateManyMethodsNames, CreateMethodsNames, CreateSelf, DbSharedOptions, DbSqlMethod, DbTableOptionScopes, DefaultColumnTypes, DefaultSchemaConfig, DeleteMethodsNames, EmptyObject, FromArg, FromResult, Grant, IsQuery, IsolationLevel, MaybeArray, MergeQuery, PickQuerySelectableRelations, QueryAfterHook, QueryBeforeActionHook, QueryBeforeHook, QueryData, QueryHasWhere, QueryOrExpression, QueryReturnType, QuerySchema, QueryScopes, RawSqlBase, RecordUnknown, RelationConfigBase, Rls, RlsPolicy, SelectableFromShape, StorageOptions, TableData, TableDataFn, TableDataItem, TransactionOptions, UpdateData, WhereArg } from "pqb/internal";
+import { Adapter, AfterCommitStandaloneHook, AfterHook, BrandColumnsShape, Column, ColumnSchemaConfig, ColumnsShape, ComputedOptionsConfig, ComputedOptionsFactory, CreateData, CreateManyMethodsNames, CreateMethodsNames, CreateSelf, DbSharedOptions, DbSqlMethod, DbTableOptionScopes, DefaultColumnTypes, DefaultSchemaConfig, DeleteMethodsNames, EmptyObject, FromArg, FromResult, Grant, IsQuery, IsolationLevel, MaybeArray, MergeQuery, PickQuerySelectableRelations, QueryAfterHook, QueryBeforeActionHook, QueryBeforeHook, QueryData, QueryHasWhere, QueryOrExpression, QueryReturnType, QuerySchema, QueryScopes, QueryTake, RawSqlBase, RecordUnknown, RelationConfigBase, Rls, RlsPolicy, SelectAsFnReturnType, SelectResultObj, SelectableFromShape, StorageOptions, TableData, TableDataFn, TableDataItem, TransactionOptions, UpdateData, WhereArg } from "pqb/internal";
 import { Db, Query } from "pqb";
 export * from "pqb";
 interface BelongsToDataForCreate<Name extends string, FK extends string, Required, Q extends Query> {
@@ -243,7 +243,7 @@ interface HasAndBelongsToManyInfo<T extends RelationConfigSelf, Name extends str
     add?: MaybeArray<WhereArg<Q>>;
   };
 }
-interface TableFactoryOptions<SchemaConfig extends ColumnSchemaConfig, ColumnTypes> {
+interface CommonTableFactoryOptions<SchemaConfig extends ColumnSchemaConfig, ColumnTypes> {
   schemaConfig?: () => SchemaConfig;
   columnTypes?: ColumnTypes | ((t: DefaultColumnTypes<SchemaConfig>) => ColumnTypes);
   snakeCase?: boolean;
@@ -254,6 +254,14 @@ interface TableFactoryOptions<SchemaConfig extends ColumnSchemaConfig, ColumnTyp
   language?: string;
   autoForeignKeys?: boolean | TableData.References.BaseOptions;
 }
+interface TableFactoryOptions<SchemaConfig extends ColumnSchemaConfig, ColumnTypes> extends CommonTableFactoryOptions<SchemaConfig, ColumnTypes> {
+  /** Default database schema for tables created by this factory. */
+  schema?: QuerySchema;
+  /** Default no-primary-key setting for tables created by this factory. */
+  noPrimaryKey?: boolean;
+  /** Default migration-generation ignore setting for tables created by this factory. */
+  generatorIgnore?: boolean;
+}
 interface OrmTable<Id extends string, Table extends string, Columns extends ColumnsShape, Relations, ColumnTypes = unknown, Computed = undefined, Scopes extends RecordUnknown | undefined = undefined, SoftDelete extends true | string | undefined = undefined, SchemaConfig extends ColumnSchemaConfig = DefaultSchemaConfig, Data extends MaybeArray<TableDataItem> = never, ReadOnly extends boolean | undefined = boolean | undefined> {
   data: {
     id: Id;
@@ -447,7 +455,7 @@ declare namespace OrmTable {
     /**
      * Exclude this table from generated migration DDL reconciliation.
      */
-    generatorIgnore?: true;
+    generatorIgnore?: boolean;
     /**
      * Auto-create foreign keys for relations of this table.
      */
@@ -466,6 +474,11 @@ declare namespace OrmTable {
   export interface DefineTable<SchemaConfig extends ColumnSchemaConfig, ColumnTypes> {
     <Table extends string, Columns extends ColumnsShape>(table: Table, t: (columnTypes: ColumnTypes) => Columns): OrmTable<Table, Table, Columns, undefined, ColumnTypes, undefined, undefined, undefined, SchemaConfig, never, undefined>;
     <Table extends string, const Options extends DefineTableOptions, Columns extends ColumnsShape>(table: Table, options: Options, t: (columnTypes: ColumnTypes) => Columns): OrmTable<DefineTableId<Table, Options>, Table, Columns, undefined, ColumnTypes, undefined, undefined, undefined, SchemaConfig, never, DefineTableReadOnly<Options>>;
+    /**
+     * Creates a table-definition helper with inherited factory options.
+     * Options provided here replace the corresponding parent options.
+     */
+    extend<ExtendedSchemaConfig extends ColumnSchemaConfig = SchemaConfig, ExtendedColumnTypes = ColumnTypes>(options: TableFactoryOptions<ExtendedSchemaConfig, ExtendedColumnTypes>): DefineTable<ExtendedSchemaConfig, ExtendedColumnTypes>;
     /**
      * Returns the file path where the table factory was defined.
      * Uses stack trace analysis to determine the caller's file path.
@@ -933,6 +946,7 @@ declare function afterCommit(this: {
 interface FromQuery extends Query {
   returnType: 'all';
 }
+type OrmSelectArg = Record<string, () => SelectAsFnReturnType>;
 interface OrchidORMQueryHelper<Q extends Query, Args extends unknown[], Result> {
   <T extends Query>(q: T & {
     table: Q['table'];
@@ -1102,6 +1116,21 @@ interface OrchidORMMethods {
    * @param args - SQL template literal, or an object { raw: string, values?: unknown[] }
    */
   $queryArrays: Db['queryArrays'];
+  /**
+   * Use `$select` to select independent query and expression results in a single SQL query.
+   * Each value is a callback returning a query or SQL expression. The helper returns a
+   * single-result query, so it can be awaited directly or further composed.
+   *
+   * ```ts
+   * const result = await db.$select({
+   *   userCount: () => db.user.count(),
+   *   one: () => sql<number>`1::int`,
+   * });
+   *
+   * // { userCount: number; one: number }
+   * ```
+   */
+  $select<Obj extends OrmSelectArg>(selection: Obj): QueryTake<SelectResultObj<Db, Obj>>;
   /**
    * See {@link FromMethods.from}
    */
@@ -1316,7 +1345,7 @@ interface ORMTableInput extends PickORMTableInputColumnsAndComputed {
    * Keep this table-like definition available at runtime, but exclude it from
    * generated migration DDL reconciliation.
    */
-  generatorIgnore?: true;
+  generatorIgnore?: boolean;
   table?: string;
   noPrimaryKey?: boolean;
   name?: string;
@@ -1631,7 +1660,7 @@ interface BaseMaterializedViewInstance<ColumnTypes> extends BaseTableInstance<Co
   readonly materialized: true;
   withData?: boolean;
 }
-declare function createBaseTable<SchemaConfig extends ColumnSchemaConfig = DefaultSchemaConfig, ColumnTypes = DefaultColumnTypes<SchemaConfig>>({ schemaConfig, columnTypes: columnTypesArg, snakeCase, filePath: filePathArg, nowSQL, exportAs, language, autoForeignKeys }?: TableFactoryOptions<SchemaConfig, ColumnTypes>): BaseTableClass<SchemaConfig, ColumnTypes>;
+declare function createBaseTable<SchemaConfig extends ColumnSchemaConfig = DefaultSchemaConfig, ColumnTypes = DefaultColumnTypes<SchemaConfig>>({ schemaConfig, columnTypes: columnTypesArg, snakeCase, filePath: filePathArg, nowSQL, exportAs, language, autoForeignKeys }?: CommonTableFactoryOptions<SchemaConfig, ColumnTypes>): BaseTableClass<SchemaConfig, ColumnTypes>;
 type QueryMethods<T extends Query> = Record<string, (q: T, ...args: any[]) => any>;
 type QueryOne<T extends Query> = { [K in keyof T]: K extends 'returnType' ? Exclude<QueryReturnType, 'all' | undefined> : T[K]; };
 interface MethodsBase<T extends Query> {
@@ -1648,4 +1677,4 @@ declare const createRepo: <T extends Query, Methods extends MethodsBase<T>>(tabl
   table: T['table'];
   shape: T['shape'];
 }>(q: Q) => Query & Q & MapMethods<T, Methods>) & T, Methods>;
-export { BaseMaterializedViewInstance, BaseTableClass, BaseTableInstance, BaseViewInstance, DefaultSelect, FromQuery, Insertable, MapMethods, MapQueryMethods, MethodsBase, ORMTableInput, OrchidORM, OrchidORMBundle, OrchidORMDbTables, OrchidORMSetupOptions, OrchidORMTables, OrchidOrmParam, OrmLegacyTableForTypeHelpers, OrmTable, OrmTableForTypeHelpers, OrmTableThunks, PickORMTableComputed, PickORMTableInputColumns, PickORMTableInputColumnsAndComputed, Queryable, Repo, Selectable, SetColumnsResult, Table$1 as Table, TableClass, TableInfo, TableInstance, TableQueryBuilder, Updatable, bundleOrchidORM, bundleOrchidORMTables, createBaseTable, createRepo, createTableFactory, defineRls, makeOrchidOrmDbWithAdapter, orchidORMWithAdapter, setGrants };
+export { BaseMaterializedViewInstance, BaseTableClass, BaseTableInstance, BaseViewInstance, type CommonTableFactoryOptions, DefaultSelect, FromQuery, Insertable, MapMethods, MapQueryMethods, MethodsBase, ORMTableInput, OrchidORM, OrchidORMBundle, OrchidORMDbTables, OrchidORMSetupOptions, OrchidORMTables, OrchidOrmParam, OrmLegacyTableForTypeHelpers, OrmTable, OrmTableForTypeHelpers, OrmTableThunks, PickORMTableComputed, PickORMTableInputColumns, PickORMTableInputColumnsAndComputed, Queryable, Repo, Selectable, SetColumnsResult, Table$1 as Table, TableClass, TableFactoryOptions, TableInfo, TableInstance, TableQueryBuilder, Updatable, bundleOrchidORM, bundleOrchidORMTables, createBaseTable, createRepo, createTableFactory, defineRls, makeOrchidOrmDbWithAdapter, orchidORMWithAdapter, setGrants };

package/dist/index.js

@@ -343,11 +343,11 @@ const createTableFactory = (options) => {
 			id,
 			table,
 			nameInDb,
-			schema: tableOptions?.schema,
-			noPrimaryKey: tableOptions?.noPrimaryKey,
+			schema: tableOptions?.schema ?? options?.schema,
+			noPrimaryKey: tableOptions?.noPrimaryKey ?? options?.noPrimaryKey,
 			snakeCase,
 			comment: tableOptions?.comment,
-			generatorIgnore: tableOptions?.generatorIgnore,
+			generatorIgnore: tableOptions?.generatorIgnore ?? options?.generatorIgnore,
 			readOnly: tableOptions?.readOnly,
 			columns: {
 				shape,
@@ -460,6 +460,10 @@ const createTableFactory = (options) => {
 	defineTable.nowSQL = options?.nowSQL;
 	defineTable.snakeCase = options?.snakeCase;
 	defineTable.language = options?.language;
+	defineTable.extend = (extendedOptions) => createTableFactory({
+		...options,
+		...extendedOptions
+	}).defineTable;
 	const defineView = ((name, optionsOrT, maybeT) => {
 		const viewOptions = typeof optionsOrT === "function" ? void 0 : optionsOrT;
 		const materialized = viewOptions?.materialized;
@@ -2755,6 +2759,7 @@ const privateOrchidORMWithAdapter = ({ log, logger, autoPreparedStatements, noPr
 		$withRecursive: qb.withRecursive.bind(qb),
 		$withSql: qb.withSql.bind(qb),
 		$from: qb.from.bind(qb),
+		$select: ((selection) => qb.select(selection).take()),
 		$close: adapter.close.bind(adapter),
 		$withOptions: qb.withOptions.bind(qb)
 	};