@easyquery/core 7.2.5-beta01 → 7.2.5-rc01

package/dist/{lib → types}/common/eq_services.d.ts

@@ -10,7 +10,8 @@ import { DataFetcher } from '../main/data_fetcher';
 import { EqValueListResolver } from '../main/value_list_resolver';
 import { QueryFileLoader } from '../main/query_file_loader';
 export declare class EqServiceProvider {
-    protected context: EqContext;
+    private static _instance;
+    static getInstance(): EqServiceProvider;
     private httpClient;
     private queryResolver;
     private modelResolver;
@@ -30,19 +31,19 @@ export declare class EqServiceProvider {
     private vlrResolver;
     private queryFileLoaderResolver;
     private aggrCalculatoResolver;
-    constructor(context: EqContext);
+    constructor();
     reset(): void;
     getHttpClient(): HttpClient;
-    createDataModel(): DataModel;
-    createQuery(): Query;
-    getModelLoader(): EqModelLoader;
-    getModelStorage(): DataModelStorage;
-    getQueryStorage(): QueryStorage;
-    getQuerySynchronizer(): QuerySynchronizer;
-    getDataFetcher(): DataFetcher;
-    getValueListResolver(): EqValueListResolver;
-    getQueryFileLoader(): QueryFileLoader;
-    getAggregatesCalculator(): AggregatesCalculator;
+    createDataModel(context: EqContext): DataModel;
+    createQuery(context: EqContext): Query;
+    getModelLoader(context: EqContext): EqModelLoader;
+    getModelStorage(context: EqContext): DataModelStorage;
+    getQueryStorage(context: EqContext): QueryStorage;
+    getQuerySynchronizer(context: EqContext): QuerySynchronizer;
+    getDataFetcher(context: EqContext): DataFetcher;
+    getValueListResolver(context: EqContext): EqValueListResolver;
+    getQueryFileLoader(context: EqContext): QueryFileLoader;
+    getAggregatesCalculator(context: EqContext): AggregatesCalculator;
     registerDataModelResolver(resolver: (context: EqContext) => DataModel): void;
     registerQueryResolver(resolver: (context: EqContext) => Query): void;
     registerModelLoaderResolver(resolver: (context: EqContext) => EqModelLoader): void;
@@ -53,4 +54,7 @@ export declare class EqServiceProvider {
     registerValueListResolver(resolver: (context: EqContext) => EqValueListResolver): void;
     registerQueryFileLoaderResolver(resolver: (context: EqContext) => QueryFileLoader): void;
     registerAggregatesCalculator(resolver: (context: EqContext) => AggregatesCalculator): void;
+    private services;
+    registerService<T>(serviceId: string, serviceResolver: () => T): void;
+    getService<T>(serviceId: string): T | undefined;
 }

package/dist/{lib → types}/dm/data_model.d.ts

@@ -5,9 +5,7 @@ import { Entity, EntityAttr } from './entity';
 import { EqValueEditor } from './value_editor';
 import { Link } from './link';
 import { DataKind } from '../types/data_kind';
-import { Query } from '../query/query';
 import { ModelPlainData } from './dto/dm_data';
-import { Tree } from '../common/tree';
 /**
  * Operator descriptor.
  */
@@ -83,11 +81,6 @@ export declare class DataModel extends MetaData {
      * @returns An instance of EqValueEditor class
      */
     createValueEditor(): ValueEditor;
-    /**
-     * Creates query.
-     * @returns The Query.
-     */
-    createQuery(): Query;
     /**
      * Gets root entity of the data model.
      * @returns The root entity.
@@ -153,20 +146,7 @@ export declare class DataModel extends MetaData {
      * @return The array of operator ids.
      */
     getOperatorIdsByDataType(type: DataType): string[];
-    /**
-     * Builds entities tree used in query.
-     * @param query The query.
-     */
-    buildQueryPath(query: Query): Tree<Entity>;
-    private createTreeNodeFromEntity;
-    /**
-     * Get Entities used in query.
-     * @param query The query.
-     */
-    getEntitiesInQuery(query: Query): Entity[];
     findAggrFunctionById(funcId: string): AggrFunction | null;
-    private fillEntitiesByCondtionGroup;
-    private addEntityByExpression;
     /**
      * Finds link between two entities.
      * @param entityFrom The entity `from`.
@@ -316,9 +296,9 @@ export declare class DataModel extends MetaData {
     */
     getTimeMacroValue(macroExpr: string): Date | null;
     /**
-     * Gets time or macro by macro value.
-     * @param macroValue The macro value.
-     * @returns The time or macro valu.
+     * Gets a time value by macor or the macro itself.
+     * @param time The macro or time value.
+     * @returns The time value or a macro that represents a particular time.
      */
     getTimeOrMacroValue(time: string): string | Date;
     getAllDateMacros(): string[];

package/dist/{lib → types}/dm/operator.d.ts

@@ -69,12 +69,12 @@ export declare class Operand {
     /**
      * Loads operand from its JSON representation object.
      * @param model The Data Model.
-     * @param data The JSON representation object.
+     * @param operand A plain JS object that represents the operand.
      */
     loadFromData(model: DataModel, operand: OperandData): void;
     /**
      * Copies operand from other operand.
-     * @param scr The operand.
+     * @param src The source operand.
      */
     copyFrom(src: Operand): void;
 }

package/dist/{lib → types}/main/context.d.ts

@@ -62,6 +62,21 @@ export declare class EqContext {
     private afterGroupFetch?;
     constructor();
     getServices(): EqServiceProvider;
+    /**
+    * Activates `Enterprise` functionality of the library. Works only with @easyquery/enterprise packag and a proper license key.
+    * @param keyOrInitCallback The license key or a callback wich is called after
+    * loading the license key from the back-end.
+    * If the callback function is called useEnterprise will try to get the license key from {base}/lck endpoint
+    *
+    * @example
+    * context.useEnterprise('license key');
+    * //or
+    * context.useEnterprise(() => {
+    *   //further logic
+    *	view.init(options);
+    * });
+    */
+    useEnterprise(this: EqContext, keyOrInitCallback: string | (() => void)): void;
     registerExporter(format: string, resolver: EqExporterResolver): void;
     registerServerExporter(format: string, responseType: XMLHttpRequestResponseType): void;
     getExporter(format: string): EqExporter | null;
@@ -70,7 +85,7 @@ export declare class EqContext {
     private endpointVarsRegex;
     resolveEndpoint(endpointKey: EqEndpointKey, options?: any): string;
     setEndpoint(key: EqEndpointKey, value: string): void;
-    setEnpointIfNotExist(key: EqEndpointKey, value: string): void;
+    setEndpointIfNotExist(key: EqEndpointKey, value: string): void;
     private setDefaultEndpoints;
     private elasticPaging;
     initStart(): void;
@@ -171,7 +186,7 @@ export declare class EqContext {
      * Throws the error passed in the function parameter.
      * If onError event handler is defined - we call that method.
      * Otherwise - just place the error message to the browser console.
-     * @param error
+     * @param status an instance of ActionStatus inteface that represents the action on which the error occurred
      */
     throwError(status: ActionStatus): void;
     /**

package/dist/types/main/context_resolver.d.ts

@@ -0,0 +1,3 @@
+import { EqContext } from "./context";
+export declare function registerEqContextResolver(resolver: () => EqContext): void;
+export declare function createEqContext(): EqContext;

package/dist/types/main/init.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/{lib → types}/public_api.d.ts

@@ -1,3 +1,4 @@
+import './main/init';
 export * from './utils/utils';
 export * from './utils/constants';
 export * from './export/exporter';
@@ -28,6 +29,7 @@ export * from './main/model_loader';
 export * from './main/model_storage';
 export * from './main/query_storage';
 export * from './main/context';
+export * from './main/context_resolver';
 export * from './main/list_cache';
 export * from './main/context_options';
 export * from './main/widget';

package/dist/{lib → types}/query/query.d.ts

@@ -1,7 +1,7 @@
 import { EventEmitter, EqEvent, AggregationColumnStore, AggregationSettings } from '@easydata/core';
 import { DataModel } from '../dm/data_model';
 import { Operator } from '../dm/operator';
-import { EntityAttr } from '../dm/entity';
+import { Entity, EntityAttr } from '../dm/entity';
 import { QueryColumn, SortDirection } from './query_column';
 import { Condition } from './condition';
 import { ExprTag } from '../types/expr_tag';
@@ -9,6 +9,7 @@ import { CondTag } from '../types/cond_tag';
 import { QueryData } from './dto/query_data';
 import { ModelPlainData } from '../dm/dto/dm_data';
 import { EqContext } from '../main/context';
+import { Tree } from '../common/tree';
 import { ColumnDescriptor, SimpleConditionDescriptor, ConditionGroupDescriptor } from './descriptors';
 import { QueryChangeEventParams, QueryChangeAction } from './query_events';
 /**
@@ -104,7 +105,7 @@ export declare class Query implements AggregationColumnStore {
     isEx(): boolean;
     /**
      * Resets the query: clears all its conditions and columns, regenerate the ID and sets the default name.
-     * @param silent Indicates whether we need to avoid firing the QueryChanged event.
+     * @param clearQuery Indicates whether we need to clear the content of the query on reset (default: true)
      */
     reset(clearQuery?: boolean): void;
     hasEnabledAggrColumns(): boolean;
@@ -125,8 +126,8 @@ export declare class Query implements AggregationColumnStore {
     private validateConditionGroup;
     /**
      * Sets data to the query.
-     * @param data JSON representation object or JSON string
-     * @param changeStatus Indicate whether we should change the "isModified" status (by default == `true`)
+     * @param data A plain JS object that represents the query or a JSON string
+     * @param options An instance of LoadQueryFromDataOptions interface that can contain different loading options
      */
     loadFromDataOrJson(data: QueryData | string, options?: LoadQueryFromDataOptions): void;
     /**
@@ -224,8 +225,7 @@ export declare class Query implements AggregationColumnStore {
      */
     setId(id: string): void;
     /**
-     * Regenerates current query ID.
-     * @param id New Query ID.
+     * Regenerates the query ID.
      */
     regenerateId(): void;
     /**
@@ -284,12 +284,12 @@ export declare class Query implements AggregationColumnStore {
     getColumnById(id: string): QueryColumn;
     /**
      * Adds a new column with specified parameters
-     * @param desriptor The descriptor of the new column. Can contain different parameters like:
+     * @param descriptor The descriptor of the new column. Can contain different parameters like:
      * `attribute` - a reference to a EntityAttr object,
      * `attributeId` - an ID of the entity attribute we need (if we don't indicate `attribute`),
      * `index`, sorting`, 'sortIndex` and other
      *
-     * @param author The author of this operation. This parameter is used in EasyQuery widgets only to indicate which of the initiates the change.
+     * @param silent Indicates if we should raise a queryChanged event. If true - the operation will be performed silently, so no event is raised.
      * @retruns The column.
      * @example
      * query.addColumn({
@@ -415,4 +415,15 @@ export declare class Query implements AggregationColumnStore {
     * Retruns conditions text
     */
     getConditionsTextAsHtml(): string;
+    /**
+     * Gets an array of all entities used in the query.
+     */
+    getEntitiesInQuery(): Entity[];
+    private fillEntitiesByCondtionGroup;
+    private addEntityByExpression;
+    /**
+     * Builds and returns the path (actually the tree) between the entities used in the query.
+     */
+    buildQueryPath(): Tree<Entity>;
+    private createTreeNodeFromEntity;
 }

package/package.json

@@ -1,18 +1,16 @@
 {
     "name": "@easyquery/core",
-    "version": "7.2.5-beta01",
+    "version": "7.2.5-rc01",
     "description": "EasyQuery.JS Community core modules",
-    "types": "./dist/lib/public_api.d.ts",
-    "main": "./dist/bundles/easyquery.core.js",
-    "module": "./dist/lib/public_api.js",
+    "types": "./dist/types/public_api.d.ts",
+    "main": "./dist/easyquery.core.cjs.js",
+    "module": "./dist/easyquery.core.esm.js",
     "scripts": {
-        "clean": "rimraf ./dist",
-        "build": "set NODE_ENV=development&& npm run clean && webpack --mode=development",
-        "build:dev": "set NODE_ENV=development&& npm run clean && tsc && webpack --mode=development",
-        "build:prod": "set NODE_ENV=production&& npm run clean && tsc && webpack --mode=production",
-        "watch": "nodemon",
-        "test": "npm run clean-test && tsc -p tsconfig-test.json && jasmine JASMINE_CONFIG_PATH=jasmine.json",
-        "clean-test": "rimraf ./test/dist"
+        "clear": "shx rm -rf dist/* docs/*",
+        "build": "npm run clear && rollup -c",
+        "watch": "npm run clear && rollup -c -w",
+        "docs": "typedoc src/public_api.ts --out ./docs",
+        "test": "jest"
     },
     "author": "Korzh.com",
     "homepage": "https://korzh.com/easyquery/javascript",
@@ -30,32 +28,10 @@
     ],
     "bugs": "https://korzh.com/support",
     "license": "LGPL-3.0",
+    "files": [
+        "dist"
+    ],
     "peerDependencies": {
-        "@easydata/core": "^1.4.18"
-    },
-    "devDependencies": {
-        "@olton/typedoc-webpack-plugin": "^0.1.0",
-        "@types/jasmine": "^4.3.2",
-        "@types/node": "20.2.5",
-        "es6-promise": "^4.2.8",
-        "jasmine": "^5.0.0",
-        "jasmine-ts-console-reporter": "^3.1.1",
-        "jsdom": "^22.1.0",
-        "nodemon": "2.0.22",
-        "rimraf": "5.0.1",
-        "terser-webpack-plugin": "^5.3.9",
-        "ts-loader": "^9.4.3",
-        "typedoc": "^0.24.7",
-        "typescript": "5.0.*",
-        "webpack": "^5.84.1",
-        "webpack-cli": "^5.1.1"
-    },
-    "nodemonConfig": {
-        "watch": [
-            "src"
-        ],
-        "delay": "1000",
-        "ext": "ts,js",
-        "exec": "tsc"
+        "@easydata/core": "^1.4.21"
     }
 }