@oino-ts/types 0.21.2 → 1.0.0

package/db/src/OINODbRequestParams.d.ts

@@ -0,0 +1,146 @@
+import { OINODbDataModel } from "./index.js";
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export declare enum OINODbSqlBooleanOperation {
+    and = "and",
+    or = "or",
+    not = "not"
+}
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export declare enum OINODbSqlComparison {
+    lt = "lt",
+    le = "le",
+    eq = "eq",
+    ge = "ge",
+    gt = "gt",
+    like = "like"
+}
+/**
+ * Class for recursively parsing of filters and printing them as SQL conditions.
+ * Supports three types of statements
+ * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+ * - negation: -not(filter)
+ * - conjunction/disjunction: (filter)-and|or(filter)
+ * Supported conditions are comparisons (<, <=, =, >=, >) and substring match (LIKE).
+ *
+ */
+export declare class OINODbSqlFilter {
+    private static _booleanOperationRegex;
+    private static _negationRegex;
+    private static _filterComparisonRegex;
+    private _leftSide;
+    private _rightSide;
+    private _operator;
+    /**
+     * Constructor of `OINODbSqlFilter`
+     * @param leftSide left side of the filter, either another filter or a column name
+     * @param operation operation of the filter, either `OINODbSqlComparison` or `OINODbSqlBooleanOperation`
+     * @param rightSide right side of the filter, either another filter or a value
+     */
+    constructor(leftSide: OINODbSqlFilter | string, operation: OINODbSqlComparison | OINODbSqlBooleanOperation | null, rightSide: OINODbSqlFilter | string);
+    /**
+     * Constructor for `OINOFilter` 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.
+     *
+     * @param leftSide left side to combine
+     * @param operation boolean operation to use in combination
+     * @param rightSide right side to combine
+     *
+     */
+    static combine(leftSide: OINODbSqlFilter | undefined, operation: OINODbSqlBooleanOperation, rightSide: OINODbSqlFilter | undefined): OINODbSqlFilter | undefined;
+    private _operatorToSql;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print filter as SQL condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+}
+/**
+ * Class for ordering select results on a number of columns.
+ *
+ */
+export declare class OINODbSqlOrder {
+    private static _orderColumnRegex;
+    private _columns;
+    private _descending;
+    /**
+     * Constructor for `OINODbSqlOrder`.
+     *
+     * @param column_or_array single or array of columns to order on
+     * @param descending_or_array single or array of booleans if ordes is descending
+     *
+     */
+    constructor(column_or_array: string[] | string, descending_or_array: boolean[] | boolean);
+    /**
+     * Constructor for `OINODbSqlOrder` as parser of http parameter.
+     *
+     * @param orderString string representation of ordering from HTTP-request
+     *
+     */
+    static parse(orderString: string): OINODbSqlOrder;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print order as SQL condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+}
+/**
+ * Class for limiting the number of results.
+ *
+ */
+export declare class OINODbSqlLimit {
+    private static _limitRegex;
+    private _limit;
+    private _page;
+    /**
+     * Constructor for `OINODbSqlLimit`.
+     *
+     * @param limit maximum number of items to return
+     *
+     */
+    constructor(limit: number, page?: number);
+    /**
+     * Constructor for `OINODbSqlLimit` as parser of http parameter.
+     *
+     * @param limitString string representation of limit from HTTP-request
+     *
+     */
+    static parse(limitString: string): OINODbSqlLimit;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print order as SQL condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+}

package/db/src/OINODbSqlParams.d.ts

@@ -0,0 +1,296 @@
+import { OINODbDataField, OINODbDataModel } from "./index.js";
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export declare enum OINODbSqlBooleanOperation {
+    and = "and",
+    or = "or",
+    not = "not"
+}
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export declare enum OINODbSqlComparison {
+    lt = "lt",
+    le = "le",
+    eq = "eq",
+    ne = "ne",
+    ge = "ge",
+    gt = "gt",
+    like = "like"
+}
+/**
+ * Supported logical conjunctions in filter predicates.
+ * @enum
+ */
+export declare enum OINODbSqlNullCheck {
+    isnull = "isnull",
+    isnotnull = "isnotnull"
+}
+/**
+ * Class for recursively parsing of filters and printing them as SQL conditions.
+ * Supports three types of statements
+ * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+ * - negation: -not(filter)
+ * - conjunction/disjunction: (filter)-and|or(filter)
+ * Supported conditions are comparisons (<, <=, =, >=, >) and substring match (LIKE).
+ *
+ */
+export declare class OINODbSqlFilter {
+    private static _booleanOperationRegex;
+    private static _negationRegex;
+    private static _filterComparisonRegex;
+    private static _filterNullCheckRegex;
+    private _leftSide;
+    private _rightSide;
+    private _operator;
+    /**
+     * Constructor of `OINODbSqlFilter`
+     * @param leftSide left side of the filter, either another filter or a column name
+     * @param operation operation of the filter, either `OINODbSqlComparison` or `OINODbSqlBooleanOperation`
+     * @param rightSide right side of the filter, either another filter or a value
+     */
+    constructor(leftSide: OINODbSqlFilter | string, operation: OINODbSqlComparison | OINODbSqlBooleanOperation | OINODbSqlNullCheck | null, rightSide: OINODbSqlFilter | string);
+    /**
+     * Constructor for `OINODbSqlFilter` as parser of http parameter.
+     *
+     * Supports three types of statements:
+     * - comparison: (field)-lt|le|eq|ge|gt|like(value)
+     * - negation: -not(filter)
+     * - conjunction/disjunction: (filter)-and|or(filter)
+     * - null check: -isnull(field) or -isnotnull(field)
+     *
+     * @param filterString string representation of filter from HTTP-request
+     *
+     */
+    static parse(filterString: string): OINODbSqlFilter;
+    /**
+     * 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
+     * @param rightSide right side to combine
+     *
+     */
+    static combine(leftSide: OINODbSqlFilter | undefined, operation: OINODbSqlBooleanOperation, rightSide: OINODbSqlFilter | undefined): OINODbSqlFilter | undefined;
+    /**
+     * Combine two filters with an AND operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static and(leftSide: OINODbSqlFilter, rightSide: OINODbSqlFilter): OINODbSqlFilter | undefined;
+    /**
+     * Combine two filters with an OR operation.
+     *
+     * @param leftSide left side filter
+     * @param rightSide right side filter
+     *
+     */
+    static or(leftSide: OINODbSqlFilter, rightSide: OINODbSqlFilter): OINODbSqlFilter | undefined;
+    /**
+     * Negate a filter with a NOT operation.
+     *
+     * @param leftSide left side filter
+     *
+     */
+    static not(leftSide: OINODbSqlFilter): OINODbSqlFilter | undefined;
+    private _operatorToSql;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print filter as SQL condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+}
+/**
+ * Class for ordering select results on a number of columns.
+ *
+ */
+export declare class OINODbSqlOrder {
+    private static _orderColumnRegex;
+    private _columns;
+    private _descending;
+    /**
+     * Constructor for `OINODbSqlOrder`.
+     *
+     * @param column_or_array single or array of columns to order on
+     * @param descending_or_array single or array of booleans if ordes is descending
+     *
+     */
+    constructor(column_or_array: string[] | string, descending_or_array: boolean[] | boolean);
+    /**
+     * Constructor for `OINODbSqlOrder` as parser of http parameter.
+     *
+     * Supports comma separated list of column orders formatted as :
+     * - `column` - order by column in ascending order
+     * - `column ASC|DESC` - order by single either ascending or descending order
+     * - `column+|-` - order by single either ascending or descending order
+     *
+     * @param orderString string representation of order from HTTP-request
+     *
+     */
+    static parse(orderString: string): OINODbSqlOrder;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print order as SQL condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    toSql(dataModel: OINODbDataModel): string;
+}
+/**
+ * Class for limiting the number of results.
+ *
+ */
+export declare class OINODbSqlLimit {
+    private static _limitRegex;
+    private _limit;
+    private _page;
+    /**
+     * Constructor for `OINODbSqlLimit`.
+     *
+     * @param limit maximum number of items to return
+     * @param page page number to return starting from 1
+     *
+     */
+    constructor(limit: number, page?: number);
+    /**
+     * Constructor for `OINODbSqlLimit` as parser of http parameter.
+     *
+     * Supports limit and page formatted as:
+     * - `limit` - limit number of items to return
+     * - `limit page n` - limit number of items to return and return page n (starting from 1)
+     * - `limit.n` - limit number of items to return and return page n (starting from 1)
+     *
+     * @param limitString string representation of limit from HTTP-request
+     *
+     */
+    static parse(limitString: string): OINODbSqlLimit;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Print order as SQL condition based on the datamodel of the API.
+     *
+     * @param dataModel data model (and database) to use for formatting of values
+     *
+     */
+    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 functions aggregate function to use
+     * @param fields fields to aggregate
+     *
+     */
+    constructor(functions: OINODbSqlAggregateFunctions[], fields: string[]);
+    /**
+     * Constructor for `OINODbSqlAggregate` as parser of http parameter.
+     *
+     * Supports comma separated list of aggregates formatted as:
+     * - `function(field)`
+     *
+     * Supported functions are count, sum, avg, min, max.
+     *
+     * @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
+     * @param select what fields to select
+     *
+     */
+    toSql(dataModel: OINODbDataModel, select?: OINODbSqlSelect): 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
+     * @param select what fields to select
+     *
+     */
+    printSqlColumnNames(dataModel: OINODbDataModel, select?: OINODbSqlSelect): string;
+    /**
+     * Does filter contain any valid conditions.
+     *
+     * @param field field to check if it is aggregated
+     */
+    isAggregated(field: OINODbDataField): boolean;
+}
+/**
+ * Class for ordering select results on a number of columns.
+ *
+ */
+export declare class OINODbSqlSelect {
+    private _columns;
+    /**
+     * Constructor for `OINODbSqlSelect`.
+     *
+     * @param columns array of columns to select
+     *
+     */
+    constructor(columns: string[]);
+    /**
+     * Constructor for `OINODbSqlSelect` as parser of http parameter.
+     *
+     * @param columns comma separated string selected columns from HTTP-request
+     *
+     */
+    static parse(columns: string): OINODbSqlSelect;
+    /**
+     * Does select contain any valid columns.
+     *
+     */
+    isEmpty(): boolean;
+    /**
+     * Does select include given column.
+     *
+     * @param field field to check if it is selected
+     *
+     */
+    isSelected(field: OINODbDataField): boolean;
+}

package/db/src/OINODbSwagger.d.ts

@@ -0,0 +1,25 @@
+import { OINODbApi } from "./index.js";
+/**
+ * Static class for Swagger utilities
+ *
+ */
+export declare class OINODbSwagger {
+    private static _getSchemaApiMethodParamsQueryId;
+    private static _getSchemaApiMethodParamsBody;
+    private static _getSchemaApiMethodDescription;
+    private static _getSchemaApiMethodOperationId;
+    private static _getSchemaOinoResponse;
+    private static _getSchemaFieldType;
+    private static _getSwaggerApiType;
+    private static _getSchemaType;
+    private static _getSchemaApiMethodParams;
+    private static _getSchemaApiMethod;
+    private static _getSwaggerApiPath;
+    /**
+     * Returns swagger.json as object of the given API's.
+     *
+     * @param apis array of API's use for Swagger definition
+     *
+     */
+    static getApiDefinition(apis: OINODbApi[]): any;
+}

package/db/src/index.d.ts

@@ -0,0 +1,6 @@
+export { OINODb } from "./OINODb.js";
+export { OINODbDataModel } from "./OINODbDataModel.js";
+export { OINODbFactory } from "./OINODbFactory.js";
+export { OINODbApi } from "./OINODbApi.js";
+export { OINODbQueryFilter, OINODbQueryOrder, OINODbQueryLimit, OINODbQueryAggregate } from "./OINODbQueryParams.js";
+export { type OINODbConstructor, type OINODbParams, OINODB_UNDEFINED } from "./OINODbConstants.js";

package/db-bunsqlite/src/OINODbBunSqlite.d.ts

@@ -0,0 +1,99 @@
+import { OINOResult, OINODataSet, OINODataCell } from "@oino-ts/common";
+import { OINODb, OINODbApi, OINODbParams } from "@oino-ts/db";
+/**
+ * Implementation of BunSqlite-database.
+ *
+ */
+export declare class OINODbBunSqlite extends OINODb {
+    private static _tableDescriptionRegex;
+    private static _tablePrimarykeyRegex;
+    private static _tableForeignkeyRegex;
+    private static _tableFieldTypeRegex;
+    private _db;
+    /**
+     * OINODbBunSqlite constructor
+     * @param params database parameters
+     */
+    constructor(params: OINODbParams);
+    private _parseDbFieldParams;
+    /**
+     * Print a table name using database specific SQL escaping.
+     *
+     * @param sqlTable name of the table
+     *
+     */
+    printTableName(sqlTable: string): string;
+    /**
+     * Print a column name with correct SQL escaping.
+     *
+     * @param sqlColumn name of the column
+     *
+     */
+    printColumnName(sqlColumn: string): string;
+    /**
+     * Print a single data value from serialization using the context of the native data
+     * type with the correct SQL escaping.
+     *
+     * @param cellValue data from sql results
+     * @param nativeType native type name for table column
+     *
+     */
+    printCellAsValue(cellValue: OINODataCell, nativeType: string): string;
+    /**
+     * Print a single string value as valid sql literal
+     *
+     * @param sqlString string value
+     *
+     */
+    printStringValue(sqlString: string): string;
+    /**
+     * Parse a single SQL result value for serialization using the context of the native data
+     * type.
+     *
+     * @param sqlValue data from serialization
+     * @param nativeType native type name for table column
+     *
+     */
+    parseValueAsCell(sqlValue: OINODataCell, nativeType: string): OINODataCell;
+    /**
+     * Connect to database.
+     *
+     */
+    connect(): Promise<OINOResult>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    validate(): Promise<OINOResult>;
+    /**
+     * Connect to database.
+     *
+     */
+    disconnect(): Promise<void>;
+    private _query;
+    private _exec;
+    /**
+     * Execute a select operation.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    sqlSelect(sql: string): Promise<OINODataSet>;
+    /**
+     * Execute other sql operations.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    sqlExec(sql: string): Promise<OINODataSet>;
+    private _getSchemaSql;
+    private _getValidateSql;
+    /**
+     * Initialize a data model by getting the SQL schema and populating OINODataFields of
+     * the model.
+     *
+     * @param api api which data model to initialize.
+     *
+     */
+    initializeApiDatamodel(api: OINODbApi): Promise<void>;
+}

package/db-bunsqlite/src/index.d.ts

@@ -0,0 +1 @@
+export { OINODbBunSqlite } from "./OINODbBunSqlite.js";

package/db-mariadb/src/OINODbMariadb.d.ts

@@ -0,0 +1,99 @@
+import { OINOResult } from "@oino-ts/common";
+import { OINODataSet, OINODataCell } from "@oino-ts/common";
+import { OINODb, OINODbApi, OINODbParams } from "@oino-ts/db";
+/**
+ * Implementation of MariaDb/MySql-database.
+ *
+ */
+export declare class OINODbMariadb extends OINODb {
+    private static _fieldLengthRegex;
+    private static _connectionExceptionMessageRegex;
+    private static _sqlExceptionMessageRegex;
+    private _pool;
+    /**
+     * Constructor of `OINODbMariadb`
+     * @param params database parameters
+     */
+    constructor(params: OINODbParams);
+    private _parseFieldLength;
+    private _query;
+    private _exec;
+    /**
+     * Print a table name using database specific SQL escaping.
+     *
+     * @param sqlTable name of the table
+     *
+     */
+    printTableName(sqlTable: string): string;
+    /**
+     * Print a column name with correct SQL escaping.
+     *
+     * @param sqlColumn name of the column
+     *
+     */
+    printColumnName(sqlColumn: string): string;
+    /**
+     * Print a single data value from serialization using the context of the native data
+     * type with the correct SQL escaping.
+     *
+     * @param cellValue data from sql results
+     * @param nativeType native type name for table column
+     *
+     */
+    printCellAsValue(cellValue: OINODataCell, nativeType: string): string;
+    /**
+     * Print a single string value as valid sql literal
+     *
+     * @param sqlString string value
+     *
+     */
+    printStringValue(sqlString: string): string;
+    /**
+     * Parse a single SQL result value for serialization using the context of the native data
+     * type.
+     *
+     * @param sqlValue data from serialization
+     * @param nativeType native type name for table column
+     *
+     */
+    parseValueAsCell(sqlValue: OINODataCell, nativeType: string): OINODataCell;
+    /**
+     * Connect to database.
+     *
+     */
+    connect(): Promise<OINOResult>;
+    /**
+     * Validate connection to database is working.
+     *
+     */
+    validate(): Promise<OINOResult>;
+    /**
+     * Disconnect from database.
+     *
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Execute a select operation.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    sqlSelect(sql: string): Promise<OINODataSet>;
+    /**
+     * Execute other sql operations.
+     *
+     * @param sql SQL statement.
+     *
+     */
+    sqlExec(sql: string): Promise<OINODataSet>;
+    private _getSchemaSql;
+    private _getValidateSql;
+    /**
+     * Initialize a data model by getting the SQL schema and populating OINODataFields of
+     * the model.
+     *
+     * @param api api which data model to initialize.
+     *
+     */
+    initializeApiDatamodel(api: OINODbApi): Promise<void>;
+}

package/db-mariadb/src/index.d.ts

@@ -0,0 +1 @@
+export { OINODbMariadb } from "./OINODbMariadb.js";