@oino-ts/types 0.2.0 → 0.3.1

package/common/src/OINOHtmlTemplate.d.ts

@@ -84,5 +84,5 @@ export declare class OINOHtmlTemplate {
      * @param includeDebugMessages include debug messages in result
      *
      */
-    renderFromResult(result: OINOResult, removeUnusedTags: boolean | undefined, messageSeparator: string, includeErrorMessages?: boolean, includeWarningMessages?: boolean, includeInfoMessages?: boolean, includeDebugMessages?: boolean): OINOHttpResult;
+    renderFromResult(result: OINOResult, removeUnusedTags?: boolean, messageSeparator?: string, includeErrorMessages?: boolean, includeWarningMessages?: boolean, includeInfoMessages?: boolean, includeDebugMessages?: boolean): OINOHttpResult;
 }

package/db/src/OINODb.d.ts

@@ -80,9 +80,10 @@ export declare abstract class OINODb {
      * @param whereCondition - The WHERE clause to filter the results.
      * @param orderCondition - The ORDER BY clause to sort the results.
      * @param limitCondition - The LIMIT clause to limit the number of results.
+     * @param groupByCondition - The GROUP BY clause to group the results.
      *
      */
-    printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string): string;
+    printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string, groupByCondition: string): string;
 }
 /**
  * Base class for SQL results that can be asynchronously iterated (but

package/db/src/OINODbApi.d.ts

@@ -79,4 +79,11 @@ export declare class OINODbApi {
      *
      */
     doRequest(method: string, id: string, body: string | OINODataRow[] | Buffer | any, params?: OINODbApiRequestParams): Promise<OINODbApiResult>;
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     *
+     */
+    isFieldIncluded(fieldName: string): boolean;
 }

package/db/src/OINODbConfig.d.ts

@@ -11,6 +11,8 @@ export declare class OINODbConfig {
     static OINODB_SQL_ORDER_PARAM: string;
     /** Name of the OINODbSqlLimit-parameter in request */
     static OINODB_SQL_LIMIT_PARAM: string;
+    /** Name of the OINODbSqlAggregate-parameter in request */
+    static OINODB_SQL_AGGREGATE_PARAM: string;
     /**
      * Set the name of the OINO ID field
      * @param idField name of the OINO ID field

package/db/src/OINODbSqlParams.d.ts

@@ -44,14 +44,14 @@ export declare class OINODbSqlFilter {
      */
     constructor(leftSide: OINODbSqlFilter | string, operation: OINODbSqlComparison | OINODbSqlBooleanOperation | null, rightSide: OINODbSqlFilter | string);
     /**
-     * Constructor for `OINOFilter` as parser of http parameter.
+     * Constructor for `OINODbSqlFilter` as parser of http parameter.
      *
      * @param filterString string representation of filter from HTTP-request
      *
      */
     static parse(filterString: string): OINODbSqlFilter;
     /**
-     * Construct a new `OINOFilter` as combination of (boolean and/or) of two filters.
+     * Construct a new `OINODbSqlFilter` as combination of (boolean and/or) of two filters.
      *
      * @param leftSide left side to combine
      * @param operation boolean operation to use in combination
@@ -145,3 +145,57 @@ export declare class OINODbSqlLimit {
      */
     toSql(dataModel: OINODbDataModel): string;
 }
+/**
+ * Supported aggregation functions in OINODbSqlAggregate.
+ * @enum
+ */
+export declare enum OINODbSqlAggregateFunctions {
+    count = "count",
+    sum = "sum",
+    avg = "avg",
+    min = "min",
+    max = "max"
+}
+/**
+ * Class for limiting the number of results.
+ *
+ */
+export declare class OINODbSqlAggregate {
+    private static _aggregateRegex;
+    private _functions;
+    private _fields;
+    /**
+     * Constructor for `OINODbSqlAggregate`.
+     *
+     * @param function aggregate function to use
+     * @param fields fields to aggregate
+     *
+     */
+    constructor(func: OINODbSqlAggregateFunctions[], fields: string[]);
+    /**
+     * Constructor for `OINODbSqlAggregate` as parser of http parameter.
+     *
+     * @param aggregatorString string representation of limit from HTTP-request
+     *
+     */
+    static parse(aggregatorString: string): OINODbSqlAggregate;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+    /**
+     * Print non-aggregated fields as SQL GROUP BY-condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    printSqlColumnNames(dataModel: OINODbDataModel): string;
+}

package/db/src/index.d.ts

@@ -3,7 +3,7 @@ export { OINOContentType };
 export { OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINOStr, OINOBenchmark, OINOLog, OINOLogLevel, OINOConsoleLog, OINOResult, OINOHttpResult, OINOHtmlTemplate } from "@oino-ts/common";
 import { OINODb } from "./OINODb.js";
 import { OINODbDataField } from "./OINODbDataField.js";
-import { OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.js";
+import { OINODbSqlAggregate, OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.js";
 export { OINODbApiResult, OINODbHtmlTemplate, OINODbApi } from "./OINODbApi.js";
 export { OINODbDataModel } from "./OINODbDataModel.js";
 export { OINODbModelSet } from "./OINODbModelSet.js";
@@ -16,6 +16,8 @@ export { OINODbSwagger } from "./OINODbSwagger.js";
 export { OINODbParser } from "./OINODbParser.js";
 /** API parameters */
 export type OINODbApiParams = {
+    /** Name of the api */
+    apiName: string;
     /** Name of the database table */
     tableName: string;
     /** Reject values that exceed field max length (behaviour on such is platform dependent) */
@@ -26,9 +28,11 @@ export type OINODbApiParams = {
     failOnInsertWithoutKey?: boolean;
     /** Treat date type fields as just strings and use the native formatting instead of the ISO 8601 format */
     useDatesAsString?: Boolean;
+    /** Include given fields from the API and exclude rest (if defined) */
+    includeFields?: string[];
     /** Exclude all fields with this prefix from the API */
     excludeFieldPrefix?: string;
-    /** Exclude given fields from the API */
+    /** Exclude given fields from the API and include rest (if defined) */
     excludeFields?: string[];
     /** Enable hashids for numeric primarykeys by adding a 32 char key */
     hashidKey?: string;
@@ -83,6 +87,8 @@ export type OINODbSqlParams = {
     order?: OINODbSqlOrder;
     /** SQL result limit condition */
     limit?: OINODbSqlLimit;
+    /** SQL aggregation functions */
+    aggregate?: OINODbSqlAggregate;
 };
 /** Request options */
 export type OINODbApiRequestParams = {

package/db-mssql/src/OINODbMsSql.d.ts

@@ -52,9 +52,10 @@ export declare class OINODbMsSql extends OINODb {
      * @param whereCondition - The WHERE clause to filter the results.
      * @param orderCondition - The ORDER BY clause to sort the results.
      * @param limitCondition - The LIMIT clause to limit the number of results.
+     * @param groupByCondition - The GROUP BY clause to group the results.
      *
      */
-    printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string): string;
+    printSqlSelect(tableName: string, columnNames: string, whereCondition: string, orderCondition: string, limitCondition: string, groupByCondition: string): string;
     /**
      * Connect to database.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oino-ts/types",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "OINO TS package for types.",
   "author": "Matias Kiviniemi (pragmatta)",
   "license": "MPL-2.0",