@oino-ts/types 0.17.1 → 0.17.3

package/db/src/OINODbDataField.d.ts

@@ -1,210 +0,0 @@
-import { OINODbDataFieldParams, OINODataCell, OINODb } from "./index.js";
-/**
- * Base class for a column of data responsible for appropriatelly serializing/deserializing the data.
- *
- */
-export declare class OINODbDataField {
-    /** OINODB reference*/
-    readonly db: OINODb;
-    /** Name of the field */
-    readonly name: string;
-    /** Internal type of field*/
-    readonly type: string;
-    /** SQL type of the field */
-    readonly sqlType: string;
-    /** Maximum length of the field (or 0) */
-    readonly maxLength: number;
-    /** Parameters for the field */
-    readonly fieldParams: OINODbDataFieldParams;
-    /**
-     * Constructor for a data field
-     *
-     * @param db OINODb reference
-     * @param name name of the field
-     * @param type internal type of the field
-     * @param sqlType column type in database
-     * @param fieldParams parameters of the field
-     * @param maxLength maximum length of the field (or 0)
-     *
-     */
-    constructor(db: OINODb, name: string, type: string, sqlType: string, fieldParams: OINODbDataFieldParams, maxLength?: number);
-    /**
-     * Pring debug information for the field
-     *
-     * @param length length of the debug output (or 0 for as long as needed)
-     *
-     */
-    printColumnDebug(length?: number): string;
-    /**
-     * 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
-     *
-     */
-    printCellAsSqlValue(cellVal: OINODataCell): string;
-    /**
-     * Print name of column as SQL.
-     *
-     */
-    printSqlColumnName(): string;
-}
-/**
- * Specialised class for a string column.
- *
- */
-export declare class OINOStringDataField extends OINODbDataField {
-    /**
-     * Constructor for a string data field
-     *
-     * @param db OINODb reference
-     * @param name name of the field
-     * @param sqlType column type in database
-     * @param fieldParams parameters of the field
-     * @param maxLength maximum length of the field (or 0)
-     *
-     */
-    constructor(db: OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams, maxLength: number);
-}
-/**
- * Specialised class for a boolean column.
- *
- */
-export declare class OINOBooleanDataField extends OINODbDataField {
-    /**
-     * Constructor for a boolean data field
-     *
-     * @param db OINODb reference
-     * @param name name of the field
-     * @param sqlType column type in database
-     * @param fieldParams parameters of the field
-     *
-     */
-    constructor(db: OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams);
-    /**
-     * 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 OINODbDataField {
-    /**
-     * Constructor for a string data field
-     *
-     * @param db OINODb reference
-     * @param name name of the field
-     * @param sqlType column type in database
-     * @param fieldParams parameters of the field
-     *
-     */
-    constructor(db: OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams);
-    /**
-     * 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 OINODbDataField {
-    /**
-     * Constructor for a blob data field
-     *
-     * @param db OINODb reference
-     * @param name name of the field
-     * @param sqlType column type in database
-     * @param fieldParams parameters of the field
-     * @param maxLength maximum length of the field (or 0)
-     *
-     */
-    constructor(db: OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams, 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 OINODbDataField {
-    /**
-     * Constructor for a string data field
-     *
-     * @param db OINODb reference
-     * @param name name of the field
-     * @param sqlType column type in database
-     * @param fieldParams parameters of the field
-     *
-     */
-    constructor(db: OINODb, name: string, sqlType: string, fieldParams: OINODbDataFieldParams);
-    /**
-     * 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;
-}

package/db/src/OINODbDataModel.d.ts

@@ -1,108 +0,0 @@
-import { OINODbDataField, OINODbApi, OINODataRow, OINODbDataFieldFilter, OINODbSqlParams } from "./index.js";
-/**
- * OINO Datamodel object for representing one database table and it's columns.
- *
- */
-export declare class OINODbDataModel {
-    private _fieldIndexLookup;
-    /** Database refererence of the table */
-    readonly api: OINODbApi;
-    /** Field refererences of the API */
-    readonly fields: OINODbDataField[];
-    /**
-     * 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: OINODbApi);
-    /**
-     * Initialize datamodel from SQL schema.
-     *
-     */
-    initialize(): Promise<void>;
-    private _printSqlColumnNames;
-    private _printSqlInsertColumnsAndValues;
-    private _printSqlUpdateValues;
-    private _printSqlPrimaryKeyCondition;
-    /**
-     * Add a field to the datamodel.
-     *
-     * @param field dataset field
-     *
-     */
-    addField(field: OINODbDataField): void;
-    /**
-     * Find a field of a given name if any.
-     *
-     * @param name name of the field to find
-     *
-     */
-    findFieldByName(name: string): OINODbDataField | 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: OINODbDataFieldFilter): OINODbDataField[];
-    /**
-     * 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[];
-    /**
-     * 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;
-    /**
-     * Print SQL select statement using optional id and filter.
-     *
-     * @param id OINO ID (i.e. combined primary key values)
-     * @param params OINO reqest params
-     *
-     */
-    printSqlSelect(id: string, params: OINODbSqlParams): string;
-    /**
-     * Print SQL insert statement from one data row.
-     *
-     * @param row one row of data in the data model
-     *
-     */
-    printSqlInsert(row: OINODataRow): string;
-    /**
-     * Print SQL insert statement from one data row.
-     *
-     * @param id OINO ID (i.e. combined primary key values)
-     * @param row one row of data in the data model
-     *
-     */
-    printSqlUpdate(id: string, row: OINODataRow): string;
-    /**
-     * Print SQL delete statement for id.
-     *
-     * @param id OINO ID (i.e. combined primary key values)
-     *
-     */
-    printSqlDelete(id: string): string;
-}

package/db/src/OINODbDataSet.d.ts

@@ -1,95 +0,0 @@
-import { OINODataRow } from "./index.js";
-/**
- * Base class for SQL results that can be asynchronously iterated (but
- * not necessarity rewinded). Idea is to handle database specific mechanisms
- * for returning and formatting conventions in the database specific
- * implementation. Data might be in memory or streamed in chunks and
- * `OINODbDataSet` will serve it out consistently.
- *
- */
-export declare abstract class OINODbDataSet {
-    private _data;
-    /** Error messages */
-    readonly messages: string[];
-    /**
-     * Constructor for `OINODbDataSet`.
-     *
-     * @param data internal database specific data type (constructor will throw if invalid)
-     * @param messages error messages from SQL-query
-     *
-     */
-    constructor(data: unknown, messages?: string[]);
-    /**
-     * Is data set empty.
-     *
-     */
-    abstract isEmpty(): boolean;
-    /**
-     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
-     *
-     */
-    abstract isEof(): boolean;
-    /**
-     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
-     *
-     */
-    abstract next(): Promise<boolean>;
-    /**
-     * Gets current row of data.
-     *
-     */
-    abstract getRow(): OINODataRow;
-    /**
-     * Checks if the messages contain errors.
-     *
-     */
-    hasErrors(): boolean;
-    /**
-     * Checks if the messages contain errors.
-     *
-     */
-    getFirstError(): string;
-}
-/**
- * Generic in memory implementation of a data set where data is an array of rows. Used
- * by BunSqlite and automated testing. Can be rewinded.
- *
- */
-export declare class OINODbMemoryDataSet extends OINODbDataSet {
-    private _rows;
-    private _currentRow;
-    private _eof;
-    /**
-     * Constructor of `OINODbMemoryDataSet`.
-     *
-     * @param data data as OINODataRow[] (constructor will throw if invalid)
-     * @param errors error messages from SQL-query
-     *
-     */
-    constructor(data: unknown, errors?: string[]);
-    /**
-     * Is data set empty.
-     *
-     */
-    isEmpty(): boolean;
-    /**
-     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
-     *
-     */
-    isEof(): boolean;
-    /**
-     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
-     *
-     */
-    next(): Promise<boolean>;
-    /**
-     * Gets current row of data.
-     *
-     */
-    getRow(): OINODataRow;
-    /**
-     * Rewinds data set to the first row, returns !isEof().
-     *
-     */
-    first(): boolean;
-}

package/db/src/OINODbFactory.d.ts

@@ -1,31 +0,0 @@
-import { OINODbApi, OINODbApiParams, OINODbParams, OINODb, OINODbConstructor } from "./index.js";
-/**
- * Static factory class for easily creating things based on data
- *
- */
-export declare class OINODbFactory {
-    private static _dbRegistry;
-    /**
-     * Register a supported database class. Used to enable those that are installed in the factory
-     * instead of forcing everyone to install all database libraries.
-     *
-     * @param dbName name of the database implementation class
-     * @param dbTypeClass constructor for creating a database of that type
-     */
-    static registerDb(dbName: string, dbTypeClass: OINODbConstructor): void;
-    /**
-     * Create database from parameters from the registered classes.
-     *
-     * @param params database connection parameters
-     * @param connect if true, connects to the database
-     * @param validate if true, validates the database connection
-     */
-    static createDb(params: OINODbParams, connect?: boolean, validate?: boolean): Promise<OINODb>;
-    /**
-     * Create API from parameters and calls initDatamodel on the datamodel.
-     *
-     * @param db databased used in API
-     * @param params parameters of the API
-     */
-    static createApi(db: OINODb, params: OINODbApiParams): Promise<OINODbApi>;
-}

package/db/src/OINODbModelSet.d.ts

@@ -1,61 +0,0 @@
-import { OINODbDataSet, OINODbDataModel, OINOContentType, OINODataCell, OINODbSqlParams } from "./index.js";
-/**
- * Class for dataset based on a data model that can be serialized to
- * a supported format:
- * - JSON (application/json)
- * - CSV (text/csv)
- *
- */
-export declare class OINODbModelSet {
-    /** Reference to datamodel */
-    readonly datamodel: OINODbDataModel;
-    /** Reference to data set */
-    readonly dataset: OINODbDataSet;
-    /** SQL parameters */
-    readonly sqlParams?: OINODbSqlParams;
-    /** Collection of errors */
-    errors: string[];
-    /**
-     * Constructor for `OINODbModelSet`.
-     *
-     * @param datamodel data model
-     * @param dataset data set
-     * @param sqlParams SQL parameters
-     */
-    constructor(datamodel: OINODbDataModel, dataset: OINODbDataSet, sqlParams?: OINODbSqlParams);
-    private _encodeAndHashFieldValue;
-    private _writeRowJson;
-    private _writeStringJson;
-    private _writeHeaderCsv;
-    private _writeRowCsv;
-    private _writeStringCsv;
-    private _writeRowFormdataParameterBlock;
-    private _writeRowFormdataFileBlock;
-    private _writeRowFormdata;
-    private _writeStringFormdata;
-    private _writeRowUrlencode;
-    private _writeStringUrlencode;
-    private _exportRow;
-    /**
-     * Serialize model set in the given format.
-     *
-     * @param [contentType=OINOContentType.json] serialization content type
-     *
-     */
-    writeString(contentType?: OINOContentType): Promise<string>;
-    /**
-     * Get value of given field in the current row. Undefined if no rows,
-     * field not found or value does not exist.
-     *
-     * @param fieldName name of the field
-     * @param serialize serialize the value
-     *
-     */
-    getValueByFieldName(fieldName: string, serialize?: boolean): OINODataCell;
-    /**
-     * Export all rows as a record with OINOId as key and object with row cells as values.
-     *
-     * @param idFieldName optional field name to use as key instead of OINOId
-     */
-    exportAsRecord(idFieldName?: string): Promise<Record<string, any>>;
-}

package/db/src/OINODbParser.d.ts

@@ -1,54 +0,0 @@
-import { OINODbDataModel, OINODataRow } from "./index.js";
-import { OINODbApiRequest } from "./OINODbApi.js";
-/**
- * Static factory class for easily creating things based on data
- *
- */
-export declare class OINODbParser {
-    /**
-     * Create data rows from request body based on the datamodel.
-     *
-     * @param datamodel datamodel of the api
-     * @param data data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
-     * @param request parameters
-     *
-     */
-    static createRows(datamodel: OINODbDataModel, data: string | object | Buffer | Uint8Array, request: OINODbApiRequest): OINODataRow[];
-    /**
-      * Create data rows from request body based on the datamodel.
-      *
-      * @param datamodel datamodel of the api
-      * @param data data as a string
-      * @param request request parameters
-      *
-      */
-    private static _createRowsFromText;
-    /**
-      * Create data rows from request body based on the datamodel.
-      *
-      * @param datamodel datamodel of the api
-      * @param data data as an Buffer or Uint8Array
-      * @param request parameters
-      *
-      */
-    private static _createRowsFromBlob;
-    /**
-     * Create one data row from javascript object based on the datamodel.
-     * NOTE! Data assumed to be unserialized i.e. of the native type (string, number, boolean, Buffer)
-     *
-     * @param datamodel datamodel of the api
-     * @param data data as javascript object
-     *
-     */
-    private static _createRowFromObject;
-    private static _findCsvLineEnd;
-    private static _parseCsvLine;
-    private static _createRowFromCsv;
-    private static _createRowFromJsonObj;
-    private static _createRowFromJson;
-    private static _findMultipartBoundary;
-    private static _parseMultipartLine;
-    private static _multipartHeaderRegex;
-    private static _createRowFromFormdata;
-    private static _createRowFromUrlencoded;
-}

package/db/src/OINODbRequestParams.d.ts

@@ -1,146 +0,0 @@
-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;
-}