orchid-orm 1.65.0 → 1.66.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { Column, TableData, ColumnsShape, Query, SelectableFromShape, CreateManyMethodsNames, QueryHasWhere, RelationConfigBase, QueryManyTake, QueryManyTakeOptional, EmptyObject, CreateData, UpdateData, WhereArg, CreateMethodsNames, MaybeArray, JoinQueryMethod, DeleteMethodsNames, Db, IsolationLevel, TransactionOptions, AfterCommitStandaloneHook, AdapterBase, FromArg, FromResult, StorageOptions, DbSharedOptions, QuerySchema, ShapeColumnPrimaryKeys, ShapeUniqueColumns, TableDataItemsUniqueColumns, TableDataItemsUniqueColumnTuples, UniqueConstraints, TableDataItemsUniqueConstraints, ComputedColumnsFromOptions, MapTableScopesOption, TableDataItem, ComputedOptionsFactory, RecordUnknown, ShallowSimplify, ComputedOptionsConfig, QueryOrExpression, QueryData, IsQuery, TableDataFn, DbTableOptionScopes, QueryScopes, ColumnSchemaConfig, DbSqlMethod, DefaultSchemaConfig, DefaultColumnTypes, QueryBeforeHook, QueryBeforeActionHook, QueryAfterHook, AfterHook, MergeQuery, QueryReturnType } from 'pqb/internal';
+import { Column, TableData, ColumnsShape, Query, RelationConfigBase, QueryManyTake, QueryManyTakeOptional, EmptyObject, CreateData, UpdateData, WhereArg, SelectableFromShape, CreateManyMethodsNames, QueryHasWhere, CreateMethodsNames, MaybeArray, JoinQueryMethod, DeleteMethodsNames, IsolationLevel, TransactionOptions, AfterCommitStandaloneHook, AdapterBase, FromArg, FromResult, StorageOptions, DbSharedOptions, ColumnSchemaConfig, DbSqlMethod, TableDataItem, QueryData, IsQuery, TableDataFn, ComputedOptionsFactory, DbTableOptionScopes, QueryScopes, RecordUnknown, QueryBeforeHook, QueryAfterHook, QueryBeforeActionHook, AfterHook, ShallowSimplify, ShapeColumnPrimaryKeys, ShapeUniqueColumns, TableDataItemsUniqueColumns, TableDataItemsUniqueColumnTuples, UniqueConstraints, TableDataItemsUniqueConstraints, ComputedColumnsFromOptions, MapTableScopesOption, ComputedOptionsConfig, QueryOrExpression, DefaultSchemaConfig, DefaultColumnTypes, QueryReturnType, MergeQuery } from 'pqb/internal';
+import { Db, QuerySchema } from 'pqb';
 export * from 'pqb';
 
 interface RelationRefsOptions<Column extends PropertyKey = string, Shape extends Column.Shape.QueryInit = Column.Shape.QueryInit> {
@@ -299,11 +300,45 @@ interface OrchidORMMethods {
      */
     $from<Arg extends MaybeArray<FromArg<Query>>>(arg: Arg): FromResult<FromQuery, Arg>;
     /**
-     * `$withOptions` supports overriding `log` and `schema`.
+     * `$withOptions` supports overriding `log`, `schema`, `role`, and `setConfig`.
      *
      * - `log`: boolean, enables or disables logging in the scope of the callback.
      * - `schema`: set a **default** schema, note that it does not override
      *   if you already have a schema set in the ORM config or for a specific table.
+     * - `role`: string, switches the Postgres role for the duration of the callback.
+     *   Used for row-level security policies.
+     * - `setConfig`: object with string, number, or boolean values, sets Postgres custom
+     *   settings for the duration of the callback. Use dotted names like `app.tenant_id`.
+     *   Values are normalized to strings internally.
+     *
+     * SQL session options (`role` and `setConfig`) cannot be nested.
+     * If an outer scope already has `role` or `setConfig`, attempting to set them again
+     * in a nested `$withOptions` call will throw an error.
+     * Nested scopes that only change `log` or `schema` will inherit the outer SQL session context.
+     *
+     * Explicit transactions inside the callback inherit the same SQL session context:
+     *
+     * ```ts
+     * await db.$withOptions(
+     *   {
+     *     role: 'app_user',
+     *     setConfig: {
+     *       'app.tenant_id': tenantId,
+     *       'app.user_id': userId,
+     *     },
+     *   },
+     *   async () => {
+     *     const project = await db.project.find(projectId);
+     *
+     *     await db.$transaction(async () => {
+     *       // This query runs in the transaction with the same role and config
+     *       await db.project.find(projectId).update({ lastViewedAt: new Date() });
+     *     });
+     *   },
+     * );
+     * ```
+     *
+     * Basic usage with `log` and `schema`:
      *
      * ```ts
      * await db.$withOptions({ log: true, schema: 'custom' }, async () => {
@@ -750,8 +785,9 @@ type MapMethods<T extends Query, Methods extends MethodsBase<T>> = {
 };
 type Repo<T extends Query, Methods extends MethodsBase<T>> = T & MapMethods<T, Methods>;
 declare const createRepo: <T extends Query, Methods extends MethodsBase<T>>(table: T, methods: Methods) => Repo<(<Q extends {
-    table: T['table'];
-    shape: T['shape'];
+    table: T["table"];
+    shape: T["shape"];
 }>(q: Q) => Query & Q & MapMethods<T, Methods>) & T, Methods>;
 
-export { type BaseTableClass, type BaseTableInstance, type DefaultSelect, type Insertable, type MapMethods, type MapQueryMethods, type MethodsBase, type ORMTableInput, type OrchidORM, type OrchidOrmParam, type Queryable, type Repo, type Selectable, type SetColumnsResult, type Table, type TableClass, type TableClasses, type TableInfo, type TableToDb, type Updatable, createBaseTable, createRepo, orchidORMWithAdapter };
+export { createBaseTable, createRepo, orchidORMWithAdapter };
+export type { BaseTableClass, BaseTableInstance, DefaultSelect, FromQuery, Insertable, MapMethods, MapQueryMethods, MethodsBase, ORMTableInput, OrchidORM, OrchidOrmParam, Queryable, Repo, Selectable, SetColumnsResult, Table, TableClass, TableClasses, TableInfo, TableToDb, Updatable };

package/dist/index.js

@@ -1,8 +1,8 @@
 'use strict';
 
 var internal = require('pqb/internal');
-var node_async_hooks = require('node:async_hooks');
 var pqb = require('pqb');
+var node_async_hooks = require('node:async_hooks');
 
 function createBaseTable({
   schemaConfig = internal.defaultSchemaConfig,
@@ -144,6 +144,7 @@ function createBaseTable({
   internal.applyMixins(base, [internal.QueryHooks]);
   base.prototype.types = columnTypes;
   base.prototype.snakeCase = snakeCase;
+  base.prototype.language = language;
   base.prototype.autoForeignKeys = autoForeignKeys === true ? {} : autoForeignKeys || void 0;
   return base;
 }
@@ -417,7 +418,7 @@ class BelongsToVirtualColumn extends internal.VirtualColumn {
       var _a;
       const value = item[key];
       const kind = value.create ? "create" : value.connect ? "connect" : "connectOrCreate";
-      if (kind) {
+      {
         const nestedCreateItem = (_a = nestedCreateItems ?? (nestedCreateItems = {}))[kind] ?? (_a[kind] = {
           items: [],
           values: []
@@ -725,7 +726,7 @@ class HasOneVirtualColumn extends internal.VirtualColumn {
         var _a;
         const value = item[this.key];
         const kind = value.create ? "create" : value.connect ? "connect" : "connectOrCreate";
-        if (kind) {
+        {
           const nestedCreateItem = (_a = nestedCreateItems ?? (nestedCreateItems = {}))[kind] ?? (_a[kind] = {
             indexes: [],
             items: [],
@@ -1443,7 +1444,7 @@ const nestedUpdate$1 = ({ query, primaryKeys, foreignKeys }) => {
     }
     if (params.add) {
       if (data.length > 1) {
-        throw new internal.OrchidOrmInternalError(
+        throw new pqb.OrchidOrmInternalError(
           query,
           "`connect` is not available when updating multiple records, it is only applicable for a single record update"
         );
@@ -1458,7 +1459,7 @@ const nestedUpdate$1 = ({ query, primaryKeys, foreignKeys }) => {
         obj
       );
       if (count < relatedWheres.length) {
-        throw new internal.OrchidOrmInternalError(
+        throw new pqb.OrchidOrmInternalError(
           query,
           `Expected to find at least ${relatedWheres.length} record(s) based on \`add\` conditions, but found ${count}`
         );
@@ -1726,7 +1727,7 @@ const makeHasAndBelongsToManyMethod = (tableConfig, table, qb, relation, relatio
             data
           );
           if (createdCount === 0) {
-            throw new internal.NotFoundError(baseQuery2);
+            throw new pqb.NotFoundError(baseQuery2);
           }
         }
       );
@@ -2023,14 +2024,14 @@ const nestedUpdate = (state) => {
           )
         ).onConflict(joinTableColumns).merge([state.foreignKeys[0]]);
         if (count < data.length * relatedWheres.length) {
-          throw new internal.OrchidOrmInternalError(
+          throw new pqb.OrchidOrmInternalError(
             query,
             `Expected to find at least ${relatedWheres.length} record(s) based on \`add\` conditions, but found ${count / data.length}`
           );
         }
       } catch (err) {
         if (err.code === "42P10") {
-          throw new internal.OrchidOrmInternalError(
+          throw new pqb.OrchidOrmInternalError(
             query,
             `"${state.joinTableQuery.table}" must have a primary key or a unique index on columns (${joinTableColumns.join(
               ", "
@@ -2319,7 +2320,7 @@ const orchidORMWithAdapter = ({
       computed: table.computed,
       nowSQL: tableClass.nowSQL
     };
-    const dbTable = new internal.Db(
+    const dbTable = new pqb.Db(
       adapter,
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
       qb,