remult 0.27.20-next.0 → 0.27.20-next.1

package/esm/src/remult3/QueryResultImpl.js

@@ -1,5 +1,4 @@
 import { queryConfig } from '../context.js';
-import { isOfType } from '../isOfType.js';
 import { Sort } from '../sort.js';
 import { RelationLoader } from './relation-loader.js';
 export class QueryResultImpl {
@@ -53,8 +52,11 @@ export class QueryResultImpl {
             include: this.options.include,
         };
         let getItems = () => this.repo.find(options);
-        if (this._aggregates === undefined &&
-            isOfType(this.options, 'aggregate')) {
+        if (this._aggregates === undefined /* &&
+        (isOfType<QueryOptions<entityType, any, any, any, any, any>>(
+          this.options,
+          'aggregate',
+        ))*/) {
             let agg = this.options.aggregate;
             if (!this.repo._dataProvider.isProxy) {
                 let itemsPromise = getItems();

package/index.d.ts

@@ -2,7 +2,7 @@ import type { ClassType } from './classType.js';
 import type { DataProvider } from './src/data-interfaces.js';
 export { ArrayEntityDataProvider } from './src/data-providers/array-entity-data-provider.js';
 export type { ClassType } from './classType.js';
-export { ValidateFieldEvent, MembersOnly, FieldsMetadata, FieldRef, IdFieldRef, FieldsRef, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, FindOptionsBase, QueryResult, QueryOptionsWithAggregates, QueryResultWithAggregates, PaginatorWithAggregates, QueryOptions, Repository, GroupByOptions, FindFirstOptions, ComparisonValueFilter, ValueFilter, IdFilter, ContainsStringValueFilter, EntityRef, SortSegments, Paginator, LiveQuery, LiveQueryChangeInfo, Subscribable, RefSubscriber, RefSubscriberBase, RelationOptions, ObjectMembersOnly, MembersToInclude, RepositoryRelations, EntityIdFields, ClassFieldDecorator, ClassFieldDecoratorContextStub, //n1 consider removing in ts5
+export { ValidateFieldEvent, MembersOnly, FieldsMetadata, FieldRef, IdFieldRef, FieldsRef, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, FindOptionsBase, QueryResult, QueryOptions, Repository, GroupByOptions, FindFirstOptions, ComparisonValueFilter, ValueFilter, IdFilter, ContainsStringValueFilter, EntityRef, SortSegments, Paginator, LiveQuery, LiveQueryChangeInfo, Subscribable, RefSubscriber, RefSubscriberBase, RelationOptions, ObjectMembersOnly, MembersToInclude, RepositoryRelations, EntityIdFields, ClassFieldDecorator, ClassFieldDecoratorContextStub, //n1 consider removing in ts5
 LifecycleEvent, FieldsRefBase, FieldsRefForEntityBase, RepositoryRelationsForEntityBase, ControllerRefForControllerBase, ControllerRefBase, ControllerRef, EntityRefForEntityBase, IdMetadata, FindFirstOptionsBase, } from './src/remult3/remult3.js';
 export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListFieldOptions, ValueListInfo, CaptionTransformer, } from './src/remult3/RepositoryImplementation.js';
 export { Entity } from './src/remult3/entity.js';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "0.27.20-next.0",
+    "version": "0.27.20-next.1",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {

package/src/remult3/QueryResultImpl.d.ts

@@ -3,7 +3,7 @@ import type { RepositoryImplementation } from './RepositoryImplementation.js';
 export declare class QueryResultImpl<entityType> implements QueryResult<entityType> {
     private options;
     private repo;
-    constructor(options: QueryOptions<entityType>, repo: RepositoryImplementation<entityType>);
+    constructor(options: QueryOptions<entityType, any, any, any, any, any>, repo: RepositoryImplementation<entityType>);
     private _count;
     private _aggregates;
     getPage(page?: number): Promise<entityType[]>;

package/src/remult3/QueryResultImpl.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.QueryResultImpl = void 0;
 var tslib_1 = require("tslib");
 var context_js_1 = require("../context.js");
-var isOfType_js_1 = require("../isOfType.js");
 var sort_js_1 = require("../sort.js");
 var relation_loader_js_1 = require("./relation-loader.js");
 var QueryResultImpl = /** @class */ (function () {
@@ -117,8 +116,11 @@ var QueryResultImpl = /** @class */ (function () {
                             include: this.options.include,
                         };
                         getItems = function () { return _this.repo.find(options); };
-                        if (this._aggregates === undefined &&
-                            (0, isOfType_js_1.isOfType)(this.options, 'aggregate')) {
+                        if (this._aggregates === undefined /* &&
+                        (isOfType<QueryOptions<entityType, any, any, any, any, any>>(
+                          this.options,
+                          'aggregate',
+                        ))*/) {
                             agg_1 = this.options.aggregate;
                             if (!this.repo._dataProvider.isProxy) {
                                 itemsPromise_1 = getItems();

package/src/remult3/RepositoryImplementation.d.ts

@@ -5,7 +5,7 @@ import { Remult } from '../context.js';
 import type { EntityOptions } from '../entity.js';
 import { Filter } from '../filter/filter-interfaces.js';
 import { type GroupByOptions, type GroupByResult, type ControllerRef, type ControllerRefForControllerBase, type EntityFilter, type EntityMetadata, type EntityOrderBy, type EntityRef, type EntityRefForEntityBase, type FieldRef, type FieldsMetadata, type FieldsRef, type FieldsRefForEntityBase, type FindFirstOptions, type FindFirstOptionsBase, type FindOptions, type IdMetadata, type LiveQuery, type LoadOptions, type MembersOnly, type NumericKeys, type Repository, type RepositoryRelations, type Subscribable, type idType } from './remult3.js';
-import type { QueryOptions, QueryOptionsWithAggregates, QueryResult, QueryResultWithAggregates, RefSubscriber } from './remult3.js';
+import type { QueryOptions, QueryResult, RefSubscriber } from './remult3.js';
 import type { entityEventListener } from '../__EntityValueProvider.js';
 import type { DataProvider, EntityDataProvider, EntityDataProviderGroupByOptions, EntityDataProviderFindOptions, ErrorInfo } from '../data-interfaces.js';
 import type { Unsubscribe } from '../live-query/SubscriptionChannel.js';
@@ -42,8 +42,7 @@ export declare class RepositoryImplementation<entityType> implements Repository<
     get metadata(): EntityMetadata<entityType>;
     listeners?: entityEventListener<entityType>[];
     addEventListener(listener: entityEventListener<entityType>): () => void;
-    query(options?: QueryOptions<entityType>): QueryResult<entityType>;
-    query<sumFields extends NumericKeys<entityType>[] | undefined = undefined, averageFields extends NumericKeys<entityType>[] | undefined = undefined, minFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, maxFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, distinctCountFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined>(options?: QueryOptionsWithAggregates<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>): QueryResultWithAggregates<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>;
+    query<sumFields extends NumericKeys<entityType>[] | undefined = undefined, averageFields extends NumericKeys<entityType>[] | undefined = undefined, minFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, maxFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, distinctCountFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined>(options?: QueryOptions<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>): QueryResult<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>;
     getEntityRef(entity: entityType): EntityRef<entityType>;
     delete(id: idType<entityType>): Promise<void>;
     delete(item: Partial<MembersOnly<entityType>>): Promise<void>;

package/src/remult3/remult3.d.ts

@@ -362,7 +362,7 @@ export type GroupByOptions<entityType, groupByFields extends (keyof MembersOnly<
 export declare const GroupByCountMember: "$count";
 export declare const GroupByForApiKey: unique symbol;
 export declare const GroupByOperators: readonly ["sum", "avg", "min", "max", "distinctCount"];
-export type GroupByResult<entityType, groupByFields extends (keyof entityType)[], sumFields extends (keyof entityType)[], averageFields extends NumericKeys<entityType>[], minFields extends NumericKeys<entityType>[], maxFields extends NumericKeys<entityType>[], distinctCountFields extends (keyof entityType)[]> = {
+export type GroupByResult<entityType, groupByFields extends (keyof entityType)[], sumFields extends NumericKeys<entityType>[], averageFields extends NumericKeys<entityType>[], minFields extends NumericKeys<entityType>[], maxFields extends NumericKeys<entityType>[], distinctCountFields extends (keyof entityType)[]> = {
     [K in groupByFields[number] | sumFields[number]]: K extends groupByFields[number] ? entityType[K] : K extends sumFields[number] ? {
         sum: number;
     } : never;
@@ -461,36 +461,16 @@ export interface Repository<entityType> {
   
      */
     aggregate<sumFields extends NumericKeys<entityType>[] | undefined = undefined, averageFields extends NumericKeys<entityType>[] | undefined = undefined, minFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, maxFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, distinctCountFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined>(options: Omit<GroupByOptions<entityType, never, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>, 'orderBy' | 'limit' | 'page' | 'group'>): Promise<GroupByResult<entityType, never, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>>;
-    /**  An alternative form of fetching data from the API server, which is intended for operating on large numbers of entity objects.
+    /**
+     * Fetches data from the repository in a way that is optimized for handling large sets of entity objects.
      *
-     * It also has it's own paging mechanism that can be used n paging scenarios.
+     * Unlike the `find` method, which returns an array, the `query` method returns an iterable `QueryResult` object.
+     * This allows for more efficient data handling, particularly in scenarios that involve paging through large amounts of data.
      *
-     * The `query` method doesn't return an array (as the `find` method) and instead returns an `iterable` `QueryResult` object
-     * which supports iterations using the JavaScript `for await` statement.
-     * @example
-     * for await (const task of taskRepo.query()) {
-     *   // do something.
-     * }
-     * @example
-     * const query = taskRepo.query({
-     *   where: { completed: false },
-     *   pageSize: 100,
-     * })
-     * const count = await query.count()
-     * console.log('Paged: ' + count / 100)
-     * let paginator = await query.paginator()
-     * console.log(paginator.items.length)
-     * if (paginator.hasNextPage) {
-     *   paginator = await paginator.nextPage()
-     *   console.log(paginator.items.length)
-     * }
-     * */
-    query(options?: QueryOptions<entityType>): QueryResult<entityType>;
-    /**
-     * Fetches data from the repository, allowing for both standard querying and aggregation in a single request.
+     * The method supports pagination and aggregation in a single request. When aggregation options are provided,
+     * the result will include both the items from the current page and the results of the requested aggregation.
      *
-     * This method supports pagination and aggregation, returning a `QueryResultWithAggregates` object that includes both
-     * the queried items for the current page and the results of the aggregation.
+     * The `query` method is designed for asynchronous iteration using the `for await` statement.
      *
      * @template entityType The type of the entity being queried.
      * @template sumFields The fields to sum, provided as an array of numeric keys from the entity type.
@@ -503,7 +483,29 @@ export interface Repository<entityType> {
      * @returns {QueryResultWithAggregates<entityType, sumFields, averageFields, minFields, maxFields, distinctCountFields>} The result of the query, including paginated items and aggregation results.
      *
      * @example
-     * // Performing a query with aggregation:
+     * // Basic usage with asynchronous iteration:
+     * for await (const task of taskRepo.query()) {
+     *   // Perform some operation on each task
+     * }
+     *
+     * @example
+     * // Querying with pagination:
+     * const query = taskRepo.query({
+     *   where: { completed: false },
+     *   pageSize: 100,
+     * });
+     *
+     * let paginator = await query.paginator();
+     * console.log('Number of items on the current page:', paginator.items.length);
+     * console.log('Total pages:', Math.ceil(paginator.aggregate.$count / 100));
+     *
+     * if (paginator.hasNextPage) {
+     *   paginator = await paginator.nextPage();
+     *   console.log('Items on the next page:', paginator.items.length);
+     * }
+     *
+     * @example
+     * // Querying with aggregation:
      * const result = await repo.query({
      *   where: { completed: false },
      *   pageSize: 50,
@@ -511,16 +513,16 @@ export interface Repository<entityType> {
      *     sum: ['salary'],
      *     average: ['age'],
      *   }
-     * });
+     * }).paginator();
      *
-     * // Accessing the items from the first page
+     * // Accessing paginated items
      * console.table(result.items);
      *
-     * // Accessing the aggregation results
-     * console.log(result.aggregates.salary.sum); // Total salary sum
-     * console.log(result.aggregates.age.average); // Average age
+     * // Accessing aggregation results
+     * console.log('Total salary:', result.aggregates.salary.sum); // Sum of all salaries
+     * console.log('Average age:', result.aggregates.age.average);  // Average age
      */
-    query<sumFields extends NumericKeys<entityType>[] | undefined = undefined, averageFields extends NumericKeys<entityType>[] | undefined = undefined, minFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, maxFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, distinctCountFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined>(options?: QueryOptionsWithAggregates<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>): QueryResultWithAggregates<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>;
+    query<sumFields extends NumericKeys<entityType>[] | undefined = undefined, averageFields extends NumericKeys<entityType>[] | undefined = undefined, minFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, maxFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined, distinctCountFields extends (keyof MembersOnly<entityType>)[] | undefined = undefined>(options?: QueryOptions<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>): QueryResult<entityType, sumFields extends undefined ? never : sumFields, averageFields extends undefined ? never : averageFields, minFields extends undefined ? never : minFields, maxFields extends undefined ? never : maxFields, distinctCountFields extends undefined ? never : distinctCountFields>;
     /** Returns a count of the items matching the criteria.
      * @see [EntityFilter](http://remult.dev/docs/entityFilter.html)
      * @example
@@ -1013,20 +1015,18 @@ export interface FindFirstOptionsBase<entityType> extends LoadOptions<entityType
     /** If set to true and an item is not found, it's created and returned*/
     createIfNotFound?: boolean;
 }
-export interface QueryOptions<entityType> extends FindOptionsBase<entityType> {
+export interface QueryOptions<entityType, sumFields extends NumericKeys<entityType>[] = never, averageFields extends NumericKeys<entityType>[] = never, minFields extends (keyof MembersOnly<entityType>)[] = never, maxFields extends (keyof MembersOnly<entityType>)[] = never, distinctCountFields extends (keyof MembersOnly<entityType>)[] = never> extends FindOptionsBase<entityType> {
     /** The number of items to return in each step */
     pageSize?: number;
     /** A callback method to indicate the progress of the iteration */
     progress?: {
         progress: (progress: number) => void;
     };
-}
-export interface QueryOptionsWithAggregates<entityType, sumFields extends NumericKeys<entityType>[], averageFields extends NumericKeys<entityType>[], minFields extends (keyof MembersOnly<entityType>)[], maxFields extends (keyof MembersOnly<entityType>)[], distinctCountFields extends (keyof MembersOnly<entityType>)[]> extends QueryOptions<entityType> {
-    aggregate: Omit<GroupByOptions<entityType, never, sumFields, averageFields, minFields, maxFields, distinctCountFields>, 'group' | 'orderBy' | 'where' | 'limit' | 'page'>;
+    aggregate?: Omit<GroupByOptions<entityType, never, sumFields, averageFields, minFields, maxFields, distinctCountFields>, 'group' | 'orderBy' | 'where' | 'limit' | 'page'>;
 }
 /** The result of a call to the `query` method in the `Repository` object.
  */
-export interface QueryResult<entityType> {
+export interface QueryResult<entityType, sumFields extends NumericKeys<entityType>[] = never, averageFields extends NumericKeys<entityType>[] = never, minFields extends (keyof MembersOnly<entityType>)[] = never, maxFields extends (keyof MembersOnly<entityType>)[] = never, distinctCountFields extends (keyof MembersOnly<entityType>)[] = never> {
     /** returns an iterator that iterates the rows in the result using a paging mechanism
      * @example
      * for await (const task of taskRepo.query()) {
@@ -1038,16 +1038,12 @@ export interface QueryResult<entityType> {
     };
     /** returns the number of rows that match the query criteria */
     count(): Promise<number>;
-    /** Returns a `Paginator` object that is used for efficient paging */
-    paginator(): Promise<Paginator<entityType>>;
     /** gets the items in a specific page */
     getPage(pageNumber?: number): Promise<entityType[]>;
     /** Performs an operation on all the items matching the query criteria */
     forEach(what: (item: entityType) => Promise<any>): Promise<number>;
-}
-export interface QueryResultWithAggregates<entityType, sumFields extends NumericKeys<entityType>[], averageFields extends NumericKeys<entityType>[], minFields extends (keyof MembersOnly<entityType>)[], maxFields extends (keyof MembersOnly<entityType>)[], distinctCountFields extends (keyof MembersOnly<entityType>)[]> extends QueryResult<entityType> {
     /** Returns a `Paginator` object that is used for efficient paging */
-    paginator(): Promise<PaginatorWithAggregates<entityType, sumFields, averageFields, minFields, maxFields, distinctCountFields>>;
+    paginator(): Promise<Paginator<entityType, sumFields, averageFields, minFields, maxFields, distinctCountFields>>;
 }
 /** An interface used to paginating using the `query` method in the `Repository` object
  *  @example
@@ -1065,18 +1061,15 @@ export interface QueryResultWithAggregates<entityType, sumFields extends Numeric
  *   console.log(paginator.items.length)
  * }
  */
-export interface Paginator<entityType> {
+export interface Paginator<entityType, sumFields extends NumericKeys<entityType>[] = never, averageFields extends NumericKeys<entityType>[] = never, minFields extends (keyof MembersOnly<entityType>)[] = never, maxFields extends (keyof MembersOnly<entityType>)[] = never, distinctCountFields extends (keyof MembersOnly<entityType>)[] = never> {
     /** the items in the current page */
     items: entityType[];
     /** True if next page exists */
     hasNextPage: boolean;
-    /** Gets the next page in the `query`'s result set */
-    nextPage(): Promise<Paginator<entityType>>;
     /** the count of the total items in the `query`'s result */
     count(): Promise<number>;
-}
-export interface PaginatorWithAggregates<entityType, sumFields extends NumericKeys<entityType>[], averageFields extends NumericKeys<entityType>[], minFields extends (keyof MembersOnly<entityType>)[], maxFields extends (keyof MembersOnly<entityType>)[], distinctCountFields extends (keyof MembersOnly<entityType>)[]> extends Paginator<entityType> {
-    nextPage(): Promise<PaginatorWithAggregates<entityType, sumFields, averageFields, minFields, maxFields, distinctCountFields>>;
+    /** Gets the next page in the `query`'s result set */
+    nextPage(): Promise<Paginator<entityType, sumFields, averageFields, minFields, maxFields, distinctCountFields>>;
     aggregates: GroupByResult<entityType, never, sumFields, averageFields, minFields, maxFields, distinctCountFields>;
 }
 /**