orchid-orm 1.34.7 → 1.34.8

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { Query, SelectableFromShape, CreateMethodsNames, CreateData, AddQueryDefaults, RelationConfigBase, UpdateData, WhereArg, JoinQueryMethod, DeleteMethodsNames, Db, IsolationLevel, TransactionOptions, Adapter, FromArg, FromResult, AdapterOptions, DbSharedOptions, RelationJoinQuery, RelationQuery, RelationsBase, ShapeColumnPrimaryKeys, ShapeUniqueColumns, TableDataItemsUniqueColumns, TableDataItemsUniqueColumnTuples, UniqueConstraints, TableDataItemsUniqueConstraints, ComputedColumnsFromOptions, MapTableScopesOption, TableDataItem, ComputedOptionsFactory, QueryData, QueryBase, TableDataFn, DbTableOptionScopes, SqlMethod, DefaultSchemaConfig, DefaultColumnTypes, QueryBeforeHook, QueryAfterHook, AfterHook, WhereResult, MergeQuery } from 'pqb';
+import { Query, SelectableFromShape, CreateMethodsNames, CreateData, AddQueryDefaults, RelationConfigBase, UpdateData, WhereArg, JoinQueryMethod, DeleteMethodsNames, Db, IsolationLevel, TransactionOptions, Adapter, FromArg, FromResult, AdapterOptions, DbSharedOptions, RelationJoinQuery, RelationQuery, RelationsBase, ShapeColumnPrimaryKeys, ShapeUniqueColumns, TableDataItemsUniqueColumns, TableDataItemsUniqueColumnTuples, UniqueConstraints, TableDataItemsUniqueConstraints, ComputedColumnsFromOptions, MapTableScopesOption, TableDataItem, ComputedOptionsFactory, QueryData, QueryBase, TableDataFn, DbTableOptionScopes, RawSQL, DynamicRawSQL, DefaultSchemaConfig, DefaultColumnTypes, QueryBeforeHook, QueryAfterHook, AfterHook, WhereResult, MergeQuery } from 'pqb';
 export * from 'pqb';
-import { ColumnsShapeBase, EmptyObject, MaybeArray, RecordUnknown, Simplify, ColumnShapeOutput, ColumnShapeInput, ColumnShapeInputPartial, CoreQueryScopes, ColumnSchemaConfig, QueryColumns, QueryReturnType } from 'orchid-core';
+import { ColumnsShapeBase, EmptyObject, MaybeArray, RecordUnknown, Simplify, ColumnShapeOutput, ColumnShapeInput, ColumnShapeInputPartial, CoreQueryScopes, ColumnSchemaConfig, StaticSQLArgs, QueryColumn, DynamicSQLArg, QueryColumns, QueryReturnType } from 'orchid-core';
 export * from 'orchid-core';
 
 interface RelationCommonOptions<Related extends TableClass = TableClass, Scope extends Query = Query> {
@@ -461,7 +461,7 @@ interface BaseTableInstance<ColumnTypes> {
      * Or you can add a computed column on the ORM level, without adding it to the database, in such a way:
      *
      * ```ts
-     * import { BaseTable } from './baseTable';
+     * import { BaseTable, sql } from './baseTable';
      *
      * export class UserTable extends BaseTable {
      *   readonly table = 'user';
@@ -473,7 +473,7 @@ interface BaseTableInstance<ColumnTypes> {
      *
      *   computed = this.setComputed({
      *     fullName: (q) =>
-     *       q.sql`${q.column('firstName')} || ' ' || ${q.column('lastName')}`.type(
+     *       sql`${q.column('firstName')} || ' ' || ${q.column('lastName')}`.type(
      *         (t) => t.string(),
      *       ),
      *   });
@@ -510,6 +510,8 @@ interface BaseTableInstance<ColumnTypes> {
      * We can define a computed `title` by passing a function into `sql` method:
      *
      * ```ts
+     * import { sql } from './baseTable';
+     *
      * type Locale = 'en' | 'uk' | 'be';
      * const asyncLanguageStorage = new AsyncLocalStorage<Locale>();
      * const defaultLocale: Locale = 'en';
@@ -524,20 +526,18 @@ interface BaseTableInstance<ColumnTypes> {
      *   }));
      *
      *   computed = this.setComputed({
-     *     title: (q) =>
-     *       q
-     *         // .sql can take a function that accepts `sql` argument and must return SQL
-     *         .sql((sql) => {
-     *           // get locale dynamically based on current storage value
-     *           const locale = asyncLanguageStorage.getStore() || defaultLocale;
-     *
-     *           // use COALESCE in case when localized title is NULL, use title_en
-     *           return sql`COALESCE(
+     *     title: () =>
+     *       // `sql` accepts a callback to generate a new query on every run
+     *       sql(() => {
+     *         // get locale dynamically based on current storage value
+     *         const locale = asyncLanguageStorage.getStore() || defaultLocale;
+     *
+     *         // use COALESCE in case when localized title is NULL, use title_en
+     *         return sql`COALESCE(
      *             ${q.column(`title_${locale}`)},
      *             ${q.column(`title_${defaultLocale}`)}
      *           )`;
-     *         })
-     *         .type((t) => t.text()),
+     *       }).type((t) => t.text()),
      *   });
      * }
      * ```
@@ -609,11 +609,13 @@ interface BaseTableInstance<ColumnTypes> {
     afterDelete: AfterSelectableHookMethod;
     afterDeleteCommit: AfterSelectableHookMethod;
 }
-interface BaseTableClass<SchemaConfig extends ColumnSchemaConfig, ColumnTypes> extends SqlMethod<ColumnTypes> {
+interface BaseTableClass<SchemaConfig extends ColumnSchemaConfig, ColumnTypes> {
     nowSQL: string | undefined;
     exportAs: string;
     columnTypes: ColumnTypes;
     getFilePath(): string;
+    sql<T>(...args: StaticSQLArgs): RawSQL<QueryColumn<T>, ColumnTypes>;
+    sql<T>(...args: [DynamicSQLArg<QueryColumn<T>>]): DynamicRawSQL<QueryColumn<T>, ColumnTypes>;
     new (): BaseTableInstance<ColumnTypes>;
     instance(): BaseTableInstance<ColumnTypes>;
     /**

package/dist/index.js

@@ -29,6 +29,11 @@ function createBaseTable({
       this.q = {};
       this.language = language;
     }
+    static sql(...args) {
+      const sql = pqb.raw(...args);
+      sql.columnTypes = columnTypes;
+      return sql;
+    }
     static inputSchema() {
       this.instance();
       return this._inputSchema === void 0 ? this._inputSchema = schemaConfig.inputSchema.call(this) : this._inputSchema;
@@ -139,7 +144,7 @@ function createBaseTable({
         options
       };
     }
-  }, _a.nowSQL = nowSQL, _a.exportAs = exportAs, _a.columnTypes = columnTypes, _a.sql = pqb.SqlMethod.prototype.sql, _a);
+  }, _a.nowSQL = nowSQL, _a.exportAs = exportAs, _a.columnTypes = columnTypes, _a);
   orchidCore.applyMixins(base, [pqb.QueryHooks]);
   base.prototype.types = columnTypes;
   base.prototype.snakeCase = snakeCase;