@oino-ts/common 0.21.1 → 1.0.0

package/dist/esm/index.js

@@ -1,36 +1,18 @@
+export { OINOApi, OINOApiRequest, OINOApiResult, OINOApiHtmlTemplate } from "./OINOApi.js";
 export { OINOBenchmark, OINOMemoryBenchmark } from "./OINOBenchmark.js";
+export { OINOConfig } from "./OINOConfig.js";
+export { OINO_ERROR_PREFIX, OINO_WARNING_PREFIX, OINO_INFO_PREFIX, OINO_DEBUG_PREFIX, OINO_REQUEST_TYPE_PARAM, OINO_RESPONSE_TYPE_PARAM, OINOContentType, OINO_EMPTY_ROW, OINO_EMPTY_ROWS } from "./OINOConstants.js";
+export { OINODataModel } from "./OINODataModel.js";
+export { OINODataSource, OINODataSet, OINOMemoryDataset } from "./OINODataSource.js";
+export { OINODataField, OINOStringDataField, OINONumberDataField, OINOBooleanDataField, OINODatetimeDataField, OINOBlobDataField } from "./OINODataField.js";
+export { OINOFormatter, OINO_EMPTY_FORMATTER } from "./OINOFormatter.js";
+export { OINOHeaders } from "./OINOHeaders.js";
+export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
 export { OINOLog, OINOLogLevel, OINOConsoleLog } from "./OINOLog.js";
-export { OINOResult, OINOHttpResult } from "./OINOResult.js";
+export { OINOModelSet } from "./OINOModelSet.js";
+export { OINOParser } from "./OINOParser.js";
+export { OINOQueryBooleanOperation, OINOQueryComparison, OINOQueryNullCheck, OINOQueryAggregateFunctions, OINOQuerySelect, OINOQueryFilter, OINOQueryOrder, OINOQueryLimit, OINOQueryAggregate } from "./OINOQueryParams.js";
 export { OINORequest, OINOHttpRequest } from "./OINORequest.js";
+export { OINOResult, OINOHttpResult } from "./OINOResult.js";
 export { OINOStr } from "./OINOStr.js";
-export { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
-export { OINOFormatter, OINO_EMPTY_FORMATTER } from "./OINOFormatter.js";
-export { OINOHeaders } from "./OINOHeaders.js";
-/** OINO error message prefix */
-export const OINO_ERROR_PREFIX = "OINO ERROR";
-/** OINO warning message prefix */
-export const OINO_WARNING_PREFIX = "OINO WARNING";
-/** OINO info message prefix */
-export const OINO_INFO_PREFIX = "OINO INFO";
-/** OINO debug message prefix */
-export const OINO_DEBUG_PREFIX = "OINO DEBUG";
-/** Name of the OINOContentType-parameter request */
-export const OINO_REQUEST_TYPE_PARAM = "oinorequesttype";
-/** Name of the OINOContentType-parameter request */
-export const OINO_RESPONSE_TYPE_PARAM = "oinoresponsetype";
-/**
- * Supported content format mime-types
- */
-export var OINOContentType;
-(function (OINOContentType) {
-    /** JSON encoded data */
-    OINOContentType["json"] = "application/json";
-    /** CSV encoded data */
-    OINOContentType["csv"] = "text/csv";
-    /** Multipart encoded form data */
-    OINOContentType["formdata"] = "multipart/form-data";
-    /** URL encoded form data */
-    OINOContentType["urlencode"] = "application/x-www-form-urlencoded";
-    /** HTML encoded data (output only) */
-    OINOContentType["html"] = "text/html";
-})(OINOContentType || (OINOContentType = {}));
+export { OINOSwagger } from "./OINOSwagger.js";

package/dist/types/OINOApi.d.ts

@@ -0,0 +1,191 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Buffer } from "node:buffer";
+import { OINOHashid } from "@oino-ts/hashid";
+import { OINOContentType, OINODataRow } from "./OINOConstants.js";
+import { OINODataSource } from "./OINODataSource.js";
+import { OINODataModel } from "./OINODataModel.js";
+import { OINOModelSet } from "./OINOModelSet.js";
+import { OINOQueryParams, OINOQueryFilter, OINOQueryOrder, OINOQueryAggregate, OINOQueryLimit, OINOQuerySelect } from "./OINOQueryParams.js";
+import { OINOHttpRequest, OINOHttpRequestInit } from "./OINORequest.js";
+import { OINOHttpResult, OINOResult } from "./OINOResult.js";
+import { OINOHtmlTemplate } from "./OINOHtmlTemplate.js";
+/** API parameters */
+export type OINOApiParams = {
+    /** 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) */
+    failOnOversizedValues?: boolean;
+    /** Reject PUT-requests that contain values for autoinc-type fields */
+    failOnUpdateOnAutoinc?: boolean;
+    /** Reject POST-requests without primary key value (can work if DB-side ) */
+    failOnInsertWithoutKey?: boolean;
+    /** Reject POST-requests without primary key value (can work if DB-side ) */
+    failOnAnyInvalidRows?: 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 and include rest (if defined) */
+    excludeFields?: string[];
+    /** Enable hashids for numeric primarykeys by adding a 32 char key */
+    hashidKey?: string;
+    /** Set (minimum) length (12-32 chars) of the hashids */
+    hashidLength?: number;
+    /** Make hashids static per row/table */
+    hashidStaticIds?: boolean;
+    /** Name of field that has the modified field */
+    cacheModifiedField?: string;
+    /** Return inserted id values */
+    returnInsertedIds?: boolean;
+};
+export type OINOApiData = string | OINODataRow[] | Buffer | Uint8Array | object | null;
+export interface OINOApiRequestInit extends OINOHttpRequestInit {
+    rowId?: string;
+    rowData?: OINOApiData;
+    queryParams?: OINOQueryParams;
+    filter?: OINOQueryFilter | string;
+    order?: OINOQueryOrder | string;
+    limit?: OINOQueryLimit | string;
+    aggregate?: OINOQueryAggregate | string;
+    select?: OINOQuerySelect | string;
+}
+export declare class OINOApiRequest extends OINOHttpRequest {
+    rowId: string;
+    rowData: OINOApiData;
+    queryParams: OINOQueryParams;
+    constructor(init: OINOApiRequestInit);
+    static fromFetchRequest(request: Request, rowId?: string, rowData?: OINOApiData, queryParams?: OINOQueryParams): Promise<OINOApiRequest>;
+    static fromHttpRequest(request: OINOHttpRequest, rowId?: string, rowData?: OINOApiData, queryParams?: OINOQueryParams): OINOApiRequest;
+}
+/**
+ * OINO API request result object with returned data and/or http status code/message and
+ * error / warning messages.
+ *
+ */
+export declare class OINOApiResult extends OINOResult {
+    /** DbApi request params */
+    request: OINOApiRequest;
+    /** Returned data if any */
+    data?: OINOModelSet;
+    /**
+     * Constructor of OINOApiResult.
+     *
+     * @param request DbApi request parameters
+     * @param data result data
+     *
+     */
+    constructor(request: OINOApiRequest, data?: OINOModelSet);
+    /**
+     * Creates a HTTP Response from API results.
+     *
+     * @param headers Headers to include in the response
+     *
+     */
+    writeApiResponse(headers?: Record<string, string>): Promise<Response>;
+}
+/**
+ * Specialized HTML template that can render ´OINOApiResult´.
+ *
+ */
+export declare class OINOApiHtmlTemplate extends OINOHtmlTemplate {
+    /** Locale validation regex */
+    static LOCALE_REGEX: RegExp;
+    /** Locale formatter */
+    protected _locale: Intl.DateTimeFormat | null;
+    protected _numberDecimals: number;
+    /**
+     * Constructor of OINOApiHtmlTemplate.
+     *
+     * @param template HTML template string
+     * @param numberDecimals Number of decimals to use for numbers, -1 for no formatting
+     * @param dateLocaleStr Datetime format string, either "iso" for ISO8601 or "default" for system default or valid locale string
+     * @param dateLocaleStyle Datetime format style, either "short/medium/long/full" or Intl.DateTimeFormat options
+     *
+     */
+    constructor(template: string, numberDecimals?: number, dateLocaleStr?: string, dateLocaleStyle?: string | any);
+    /**
+     * Creates HTML Response from API modelset.
+     *
+     * @param modelset OINO API dataset
+     * @param overrideValues values to override in the data
+     *
+     */
+    renderFromDbData(modelset: OINOModelSet, overrideValues?: any): Promise<OINOHttpResult>;
+}
+/**
+ * API class with method to process HTTP REST requests.
+ *
+ */
+export declare abstract class OINOApi {
+    /** Enable debug output on errors */
+    protected _debugOnError: boolean;
+    /** API database reference */
+    readonly datasource: OINODataSource;
+    /** API parameters */
+    readonly params: OINOApiParams;
+    /** API hashid */
+    readonly hashid: OINOHashid | null;
+    /** Is API initialized */
+    initialized: boolean;
+    /** API datamodel */
+    datamodel: OINODataModel | null;
+    constructor(datasource: OINODataSource, params: OINOApiParams);
+    /**
+     * Method for handling a HTTP REST request with GET, POST, PUT, DELETE corresponding to
+     * SQL select, insert, update and delete.
+     *
+     * @param request OINO HTTP request object containing all parameters of the REST request
+     * @param rowId URL id of the REST request
+     * @param rowData HTTP body data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
+     * @param queryParams SQL parameters for the REST request
+     *
+     */
+    abstract doHttpRequest(request: OINOHttpRequest, rowId: string, rowData: OINOApiData, queryParams: OINOQueryParams): Promise<OINOApiResult>;
+    /**
+     * Method for handling a HTTP REST request with GET, POST, PUT, DELETE corresponding to
+     * SQL select, insert, update and delete.
+     *
+     * @param method HTTP method of the REST request
+     * @param rowId URL id of the REST request
+     * @param rowData HTTP body data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
+     * @param queryParams SQL parameters for the REST request
+     * @param contentType content type of the HTTP body data, default is JSON
+     *
+     */
+    abstract doRequest(method: string, rowId: string, rowData: OINOApiData, queryParams: OINOQueryParams, contentType: OINOContentType): Promise<OINOApiResult>;
+    abstract doApiRequest(request: OINOApiRequest): Promise<OINOApiResult>;
+    /**
+     * Method for handling a HTTP REST request with batch update using PUT or DELETE methods.
+     *
+     * @param method HTTP method of the REST request
+     * @param rowId URL id of the REST request
+     * @param rowData HTTP body data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
+     *
+     */
+    abstract doBatchUpdate(method: string, rowId: string, rowData: OINOApiData, queryParams?: OINOQueryParams): Promise<OINOApiResult>;
+    /**
+     * Method for handling a HTTP REST request with batch update using PUT or DELETE methods.
+     *
+     * @param request HTTP URL parameters as key-value-pairs
+     *
+     */
+    abstract doBatchApiRequest(request: OINOApiRequest): Promise<OINOApiResult>;
+    /**
+     * Enable or disable debug output on errors.
+     *
+     * @param debugOnError true to enable debug output on errors, false to disable
+     */
+    setDebugOnError(debugOnError: boolean): void;
+    /**
+     * Method to check if a field is included in the API params.
+     *
+     * @param fieldName name of the field
+     *
+     */
+    isFieldIncluded(fieldName: string): boolean;
+}

package/dist/types/OINOBenchmark.d.ts

@@ -105,7 +105,7 @@ export declare abstract class OINOBenchmark {
     static trackMetric(module: string, method: string, value: number, success?: boolean): void;
     protected abstract _trackException(module: string, method: string, name: string, message: string, stack: string): void;
     /**
-     * Track an exception
+     * Track an exception. Does not consider enabled modules.
      *
      * @param module of the benchmark
      * @param method of the benchmark

package/dist/types/OINOConfig.d.ts

@@ -0,0 +1,63 @@
+/** Set the name of the OINO ID field (default \_OINOID\_) */
+export declare class OINOConfig {
+    /** Name of the synthetic OINO ID field */
+    static OINO_ID_FIELD: string;
+    /** Private key separator of the synthetic OINO ID field */
+    static OINO_ID_SEPARATOR: string;
+    private static OINO_ID_SEPARATOR_ESCAPED;
+    /** Name of the OINODbQueryFilter-parameter in request */
+    static OINO_QUERY_FILTER_PARAM: string;
+    /** Name of the OINODbQueryOrder-parameter in request */
+    static OINO_QUERY_ORDER_PARAM: string;
+    /** Name of the OINODbQueryLimit-parameter in request */
+    static OINO_QUERY_LIMIT_PARAM: string;
+    /** Name of the OINODbQueryAggregate-parameter in request */
+    static OINO_QUERY_AGGREGATE_PARAM: string;
+    /** Name of the OINODbSqlSelect-parameter in request */
+    static OINO_QUERY_SELECT_PARAM: string;
+    /**
+     * Set the name of the OINO ID field
+     * @param idField name of the OINO ID field
+     */
+    static setOinoIdField(idField: string): void;
+    /**
+     * Set the separator character of the OINO ID field
+     * @param idSeparator character to use as separator of id parts
+    */
+    static setOinoIdSeparator(idSeparator: string): void;
+    /**
+     * Print OINO ID for primary key values.
+     *
+     * @param primaryKeys an array of primary key values.
+     *
+     */
+    static printOINOId(primaryKeys: string[]): string;
+    /**
+     * Print OINO ID for primary key values.
+     *
+     * @param oinoid the OINO ID string to parse as primary key values.
+     *
+     */
+    static parseOINOId(oinoid: string): string[];
+    /**
+     * Set the name of the OINODbQueryFilter-param field
+     *
+     * @param sqlFilterParam name of the http parameter with `OINODbQueryFilter` definition
+     *
+     */
+    static setOinoQueryFilterParam(sqlFilterParam: string): void;
+    /**
+     * Set the name of the OINODbQueryOrder-param field
+     *
+     * @param sqlOrderParam name of the http parameter with `OINODbQueryOrder` definition
+     *
+     */
+    static setOinoQueryOrderParam(sqlOrderParam: string): void;
+    /**
+     * Set the name of the OINODbQueryLimit-param field
+     *
+     * @param sqlLimitParam name of the http parameter with `OINODbQueryLimit` definition
+     *
+     */
+    static setOinoQueryLimitParam(sqlLimitParam: string): void;
+}

package/dist/types/OINOConstants.d.ts

@@ -0,0 +1,51 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Buffer } from "node:buffer";
+/** OINO error message prefix */
+export declare const OINO_ERROR_PREFIX = "OINO ERROR";
+/** OINO warning message prefix */
+export declare const OINO_WARNING_PREFIX = "OINO WARNING";
+/** OINO info message prefix */
+export declare const OINO_INFO_PREFIX = "OINO INFO";
+/** OINO debug message prefix */
+export declare const OINO_DEBUG_PREFIX = "OINO DEBUG";
+/** Name of the OINOContentType-parameter request */
+export declare const OINO_REQUEST_TYPE_PARAM = "oinorequesttype";
+/** Name of the OINOContentType-parameter request */
+export declare const OINO_RESPONSE_TYPE_PARAM = "oinoresponsetype";
+/** Name of the query parameter that triggers a file download response */
+export declare const OINO_RESPONSE_DOWNLOAD_PARAM = "oinoresponsedownload";
+/**
+ * Supported content format mime-types
+ */
+export declare enum OINOContentType {
+    /** JSON encoded data */
+    json = "application/json",
+    /** CSV encoded data */
+    csv = "text/csv",
+    /** Multipart encoded form data */
+    formdata = "multipart/form-data",
+    /** URL encoded form data */
+    urlencode = "application/x-www-form-urlencoded",
+    /** HTML encoded data (output only) */
+    html = "text/html"
+}
+/** Field parameters in database */
+export type OINODataFieldParams = {
+    /** Is the field a primary key */
+    isPrimaryKey: boolean;
+    /** Is the field a primary key */
+    isForeignKey: boolean;
+    /** Is the field an auto inc type */
+    isAutoInc: boolean;
+    /** Is the field allowed to have null values */
+    isNotNull: boolean;
+};
+/** A single column value of a data row */
+export type OINODataCell = string | bigint | number | boolean | Date | Uint8Array | Buffer | null | undefined;
+/** A single data row */
+export type OINODataRow = Array<OINODataCell>;
+/** Empty row instance */
+export declare const OINO_EMPTY_ROW: OINODataRow;
+/** Empty row array instance */
+export declare const OINO_EMPTY_ROWS: OINODataRow[];

package/dist/types/OINODataField.d.ts

@@ -0,0 +1,209 @@
+import { OINODataFieldParams, OINODataCell } from "./OINOConstants.js";
+import { OINODataSource } from "./OINODataSource.js";
+/**
+ * Base class for a column of data responsible for appropriatelly serializing/deserializing the data.
+ *
+ */
+export declare class OINODataField {
+    /** OINO data source reference*/
+    readonly datasource: OINODataSource;
+    /** Name of the field */
+    readonly name: string;
+    /** Internal type of field*/
+    readonly type: string;
+    /** SQL type of the field */
+    readonly nativeType: string;
+    /** Maximum length of the field (or 0) */
+    readonly maxLength: number;
+    /** Parameters for the field */
+    readonly fieldParams: OINODataFieldParams;
+    /**
+     * Constructor for a data field
+     *
+     * @param datasource OINO data source reference
+     * @param name name of the field
+     * @param type internal type of the field
+     * @param nativeType column type in database
+     * @param fieldParams parameters of the field
+     * @param maxLength maximum length of the field (or 0)
+     *
+     */
+    constructor(datasource: OINODataSource, name: string, type: string, nativeType: string, fieldParams: OINODataFieldParams, maxLength?: number);
+    /**
+     * Serialize cell value in the given content format.
+     *
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell): string | null | undefined;
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     *
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string | null | undefined): OINODataCell;
+    /**
+     * Print data cell (from deserialization) as SQL-string.
+     *
+     * @param cellVal cell value
+     *
+     */
+    printCellAsValue(cellVal: OINODataCell): string;
+    /**
+     * Print name of column as SQL.
+     *
+     */
+    printColumnName(): string;
+}
+/**
+ * Specialised class for a string column.
+ *
+ */
+export declare class OINOStringDataField extends OINODataField {
+    /**
+     * Constructor for a string data field
+     *
+     * @param datasource OINO data source reference
+     * @param name name of the field
+     * @param nativeType column type in database
+     * @param fieldParams parameters of the field
+     * @param maxLength maximum length of the field (or 0)
+     *
+     */
+    constructor(datasource: OINODataSource, name: string, nativeType: string, fieldParams: OINODataFieldParams, maxLength: number);
+}
+/**
+ * Specialised class for a boolean column.
+ *
+ */
+export declare class OINOBooleanDataField extends OINODataField {
+    /**
+     * Constructor for a boolean data field
+     *
+     * @param datasource OINO data source reference
+     * @param name name of the field
+     * @param nativeType column type in database
+     * @param fieldParams parameters of the field
+     *
+     */
+    constructor(datasource: OINODataSource, name: string, nativeType: string, fieldParams: OINODataFieldParams);
+    /**
+     * Serialize cell value in the given content format.
+     *
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell): string | null | undefined;
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     *
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string | null | undefined): OINODataCell;
+}
+/**
+ * Specialised class for a number column.
+ *
+ */
+export declare class OINONumberDataField extends OINODataField {
+    /**
+     * Constructor for a string data field
+     *
+     * @param datasource OINO data source reference
+     * @param name name of the field
+     * @param nativeType column type in database
+     * @param fieldParams parameters of the field
+     *
+     */
+    constructor(datasource: OINODataSource, name: string, nativeType: string, fieldParams: OINODataFieldParams);
+    /**
+     * Serialize cell value in the given content format.
+     *
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell): string | null | undefined;
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     *
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string | null | undefined): OINODataCell;
+}
+/**
+ * Specialised class for a blob column.
+ *
+ */
+export declare class OINOBlobDataField extends OINODataField {
+    /**
+     * Constructor for a blob data field
+     *
+     * @param datasource OINO data source reference
+     * @param name name of the field
+     * @param nativeType column type in database
+     * @param fieldParams parameters of the field
+     * @param maxLength maximum length of the field (or 0)
+     *
+     */
+    constructor(datasource: OINODataSource, name: string, nativeType: string, fieldParams: OINODataFieldParams, maxLength: number);
+    /**
+     * Serialize cell value in the given content format.
+     *
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell): string | null | undefined;
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     *
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string | null | undefined): OINODataCell;
+}
+/**
+ * Specialised class for a datetime column.
+ *
+ */
+export declare class OINODatetimeDataField extends OINODataField {
+    /**
+     * Constructor for a string data field
+     *
+     * @param datasource OINO data source reference
+     * @param name name of the field
+     * @param nativeType column type in database
+     * @param fieldParams parameters of the field
+     *
+     */
+    constructor(datasource: OINODataSource, name: string, nativeType: string, fieldParams: OINODataFieldParams);
+    /**
+     * Serialize cell value in the given content format.
+     *
+     * @param cellVal cell value
+     *
+     */
+    serializeCell(cellVal: OINODataCell): string | null | undefined;
+    /**
+     * Serialize cell value in the given content format.
+     *
+     * @param cellVal cell value
+     * @param locale locale-object to format datetimes with
+     *
+     */
+    serializeCellWithLocale(cellVal: OINODataCell, locale: Intl.DateTimeFormat): string | null | undefined;
+    /**
+     * Parce cell value from string using field type specific formatting rules.
+     *
+     * @param value string value
+     *
+     */
+    deserializeCell(value: string | null | undefined): OINODataCell;
+}
+/**
+ * Callback to filter data fields
+ * @param field fields to filter
+ */
+export type OINODataFieldFilter = (field: OINODataField) => Boolean;

package/dist/types/OINODataModel.d.ts

@@ -0,0 +1,78 @@
+import { OINODataRow } from "./OINOConstants.js";
+import { OINOApi } from "./OINOApi.js";
+import { OINODataField, OINODataFieldFilter } from "./OINODataField.js";
+/**
+ * OINO Datamodel object for representing one database table and it's columns.
+ *
+ */
+export declare class OINODataModel {
+    private _fieldIndexLookup;
+    /** Database refererence of the table */
+    readonly api: OINOApi;
+    /** Field refererences of the API */
+    readonly fields: OINODataField[];
+    /**
+     * Constructor of the data model.
+     * NOTE! OINODbDataModel.initialize must be called after constructor to populate fields.
+     *
+     * @param api api of the data model
+     *
+     */
+    constructor(api: OINOApi);
+    /**
+     * Add a field to the datamodel.
+     *
+     * @param field dataset field
+     *
+     */
+    addField(field: OINODataField): void;
+    /**
+     * Find a field of a given name if any.
+     *
+     * @param name name of the field to find
+     *
+     */
+    findFieldByName(name: string): OINODataField | null;
+    /**
+     * Find index of a field of a given name if any.
+     *
+     * @param name name of the field to find
+     *
+     */
+    findFieldIndexByName(name: string): number;
+    /**
+     * Find all fields based of given filter callback criteria (e.g. fields of certain data type, primary keys etc.)
+     *
+     * @param filter callback called for each field to include or not
+     *
+     */
+    filterFields(filter: OINODataFieldFilter): OINODataField[];
+    /**
+     * Return the primary key values of one row in order of the data model
+     *
+     * @param row data row
+     * @param hashidValues apply hashid when applicable
+     *
+     */
+    getRowPrimarykeyValues(row: OINODataRow, hashidValues?: boolean): string[];
+    /**
+     * Pring debug information for the field
+     *
+     * @param length length of the debug output (or 0 for as long as needed)
+     *
+     */
+    printColumnDebug(field: OINODataField, length?: number): string;
+    /**
+     * Print debug information about the fields.
+     *
+     * @param separator string to separate field prints
+     *
+     */
+    printDebug(separator?: string): string;
+    /**
+     * Print all public properties (db, table name, fields) of the datamodel. Used
+     * in automated testing validate schema has stayed the same.
+     *
+     */
+    printFieldPublicPropertiesJson(): string;
+}