remult - npm Package Compare versions

Comparing version 0.8.3 to 0.9.1

index.d.ts

@@ -1,2 +0,2 @@
-export { Field, FieldsMetadata, Entity, EntityBase, FieldRef, Fields, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, IterableResult, IterateOptions, Repository, FieldType, FindFirstOptions, ComparisonValueFilter, ValueFilter, ContainsStringValueFilter, getFields, EntityRef, getEntityRef, SortSegments, ValueListFieldType, DateOnlyField, IntegerField, CaptionTransformer } from './src/remult3';
+export { Field, FieldsMetadata, Entity, EntityBase, FieldRef, Fields, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, QueryResult, QueryOptions, Repository, FieldType, FindFirstOptions, ComparisonValueFilter, ValueFilter, ContainsStringValueFilter, getFields, EntityRef, getEntityRef, SortSegments, ValueListFieldType, DateOnlyField, IntegerField, CaptionTransformer } from './src/remult3';
 export { EntityOptions } from './src/entity';
@@ -14,3 +14,3 @@ export { DataProvider, EntityDataProvider, EntityDataProviderFindOptions, ErrorInfo, RestDataProviderHttpProvider } from './src/data-interfaces';
 export { Controller, BackendMethodOptions, BackendMethod, ProgressListener } from './src/server-action';
-export { Allowed, Allow, Remult, isBackend, AllowedForInstance, EventDispatcher, EventSource, HttpProvider, IterateToArrayOptions, Unobserve, UserInfo } from './src/context';
+export { Allowed, Allow, Remult, isBackend, AllowedForInstance, EventDispatcher, EventSource, HttpProvider, Unobserve, UserInfo } from './src/context';
 export { IdEntity } from './src/id-entity';
@@ -17,0 +17,0 @@ export { SortSegment, Sort } from './src/sort';

package.json

 {
     "name": "remult",
-    "version": "0.8.3",
+    "version": "0.9.1",
     "description": "remult core lib",
@@ -5,0 +5,0 @@ "homepage": "https://remult.github.io/",

src/context.d.ts

@@ -63,8 +63,4 @@ import { DataProvider } from "./data-interfaces";
 }
-export interface IterateToArrayOptions {
-    limit?: number;
-    page?: number;
-}
-export declare const iterateConfig: {
-    pageSize: number;
+export declare const queryConfig: {
+    defaultPageSize: number;
 };
@@ -71,0 +67,0 @@ export interface EventDispatcher {

src/context.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EventSource = exports.iterateConfig = exports.Allow = exports.setControllerSettings = exports.MethodHelper = exports.ClassHelper = exports.classHelpers = exports.allEntities = exports.Remult = exports.isBackend = exports.processHttpException = exports.toPromise = void 0;
+exports.EventSource = exports.queryConfig = exports.Allow = exports.setControllerSettings = exports.MethodHelper = exports.ClassHelper = exports.classHelpers = exports.allEntities = exports.Remult = exports.isBackend = exports.processHttpException = exports.toPromise = void 0;
 var tslib_1 = require("tslib");
@@ -326,4 +326,4 @@ var server_action_1 = require("./server-action");
 exports.Allow = Allow;
-exports.iterateConfig = {
-    pageSize: 200
+exports.queryConfig = {
+    defaultPageSize: 200
 };
@@ -330,0 +330,0 @@ var EventSource = /** @class */ (function () {

src/remult3/remult3.d.ts

 import { ClassType } from "../../classType";
 import { FieldMetadata } from "../column-interfaces";
-import { IterateToArrayOptions, Unobserve } from "../context";
+import { Unobserve } from "../context";
 import { EntityOptions as EntityOptions } from "../entity";
@@ -78,3 +78,3 @@ import { SortSegment } from "../sort";
     find(options?: FindOptions<entityType>): Promise<entityType[]>;
-    iterate(options?: IterateOptions<entityType>): IterableResult<entityType>;
+    query(options?: QueryOptions<entityType>): QueryResult<entityType>;
     findFirst(where?: EntityFilter<entityType>, options?: FindFirstOptions<entityType>): Promise<entityType>;
@@ -168,3 +168,3 @@ findId(id: entityType extends {
 }
-export interface IterateOptions<entityType> extends FindOptionsBase<entityType> {
+export interface QueryOptions<entityType> extends FindOptionsBase<entityType> {
     pageSize?: number;
@@ -175,7 +175,7 @@ progress?: {
 }
-export interface IterableResult<entityType> {
-    toArray(options?: IterateToArrayOptions): Promise<entityType[]>;
-    first(): Promise<entityType>;
+export interface QueryResult<entityType> {
+    getArray(page?: number): Promise<entityType[]>;
     count(): Promise<number>;
     forEach(what: (item: entityType) => Promise<any>): Promise<number>;
+    paginate(): Promise<Paginator<entityType>>;
     [Symbol.asyncIterator](): {
@@ -185,1 +185,7 @@ next: () => Promise<IteratorResult<entityType, entityType>>;
 }
+export interface Paginator<entityType> {
+    items: entityType[];
+    count(): Promise<number>;
+    hasNextPage: boolean;
+    nextPage(): Promise<Paginator<entityType>>;
+}

src/remult3/RepositoryImplementation.d.ts

 import { FieldMetadata, FieldOptions, ValueListItem } from "../column-interfaces";
 import { EntityOptions } from "../entity";
 import { LookupColumn } from '../column';
-import { EntityMetadata, FieldRef, Fields, EntityFilter, FindOptions, Repository, EntityRef, IterateOptions, IterableResult, EntityOrderBy, FieldsMetadata, IdMetadata, FindFirstOptionsBase, FindFirstOptions, PartialEB } from "./remult3";
+import { EntityMetadata, FieldRef, Fields, EntityFilter, FindOptions, Repository, EntityRef, QueryOptions, QueryResult, EntityOrderBy, FieldsMetadata, IdMetadata, FindFirstOptionsBase, FindFirstOptions, PartialEB } from "./remult3";
 import { ClassType } from "../../classType";
@@ -25,3 +25,3 @@ import { Remult } from "../context";
     addEventListener(listener: entityEventListener<entityType>): () => void;
-    iterate(options?: IterateOptions<entityType>): IterableResult<entityType>;
+    query(options?: QueryOptions<entityType>): QueryResult<entityType>;
     getEntityRef(entity: entityType): EntityRef<entityType>;
@@ -28,0 +28,0 @@ delete(entity: entityType): Promise<void>;

No alert changes

Improved metrics

Total package byte prevSize

632433

increased by0.14%

Lines of code

9557

increased by0.19%

No dependency changes