@oino-ts/db 0.0.17 → 0.1.0

package/dist/types/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;
-}

package/dist/types/OINODbSwagger.d.ts

@@ -1,25 +0,0 @@
-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/dist/types/index.d.ts

@@ -1,111 +0,0 @@
-import { OINOContentType } from "@oino-ts/types";
-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/types";
-import { OINODb } from "./OINODb.js";
-import { OINODbDataField } from "./OINODbDataField.js";
-import { OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbRequestParams.js";
-export { OINODbApiResult, OINODbHtmlTemplate, OINODbApi } from "./OINODbApi.js";
-export { OINODbDataModel } from "./OINODbDataModel.js";
-export { OINODbModelSet } from "./OINODbModelSet.js";
-export { OINODbDataField, OINOBooleanDataField, OINONumberDataField, OINOStringDataField, OINOBlobDataField, OINODatetimeDataField } from "./OINODbDataField.js";
-export { OINODb } from "./OINODb.js";
-export { OINODbDataSet, OINODbMemoryDataSet } from "./OINODbDataSet.js";
-export { OINODbSqlFilter, OINODbSqlOrder, OINODbSqlComparison, OINODbSqlLimit, OINODbSqlBooleanOperation } from "./OINODbRequestParams.js";
-export { OINODbConfig } from "./OINODbConfig.js";
-export { OINODbFactory } from "./OINODbFactory.js";
-export { OINODbSwagger } from "./OINODbSwagger.js";
-/** API parameters */
-export type OINODbApiParams = {
-    /** 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;
-    /** Treat date type fields as just strings and use the native formatting instead of the ISO 8601 format */
-    useDatesAsString?: Boolean;
-    /** Exclude all fields with this prefix from the API */
-    excludeFieldPrefix?: string;
-    /** Exclude given fields from the API */
-    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;
-};
-/**
- * Database class (constructor) type
- * @param dbParams database parameters
- */
-export type OINODbConstructor = new (dbParams: OINODbParams) => OINODb;
-/** Database parameters */
-export type OINODbParams = {
-    /** Name of the database class (e.g. OINODbPostgresql)  */
-    type: string;
-    /** Connection URL, either file://-path or an IP-address or an HTTP-url */
-    url: string;
-    /** Name of the database */
-    database: string;
-    /** TCP port of the database */
-    port?: number;
-    /** Username used to authenticate */
-    user?: string;
-    /** Password used to authenticate */
-    password?: string;
-};
-/** Field parameters in database */
-export type OINODbDataFieldParams = {
-    /** 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;
-};
-/**
- * Callback to filter data fields
- * @param field fields to filter
- */
-export type OINODbDataFieldFilter = (field: OINODbDataField) => Boolean;
-/** Request options */
-export type OINODbSqlParams = {
-    /** Additional SQL select where-conditions */
-    filter?: OINODbSqlFilter;
-    /** SQL result ordering conditions */
-    order?: OINODbSqlOrder;
-    /** SQL result limit condition */
-    limit?: OINODbSqlLimit;
-};
-/** Request options */
-export type OINODbApiRequestParams = {
-    /** Content type of the request body */
-    requestType?: OINOContentType;
-    /** Content type of the response body */
-    responseType?: OINOContentType;
-    /** Multipart boundary token */
-    multipartBoundary?: string;
-    /** Request last-modified value */
-    lastModified?: number;
-    /** Request etag values */
-    etags?: string[];
-    /** SQL parameters */
-    sqlParams?: OINODbSqlParams;
-};
-/** 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 OINODB_EMPTY_ROW: OINODataRow;
-/** Empty row array instance */
-export declare const OINODB_EMPTY_ROWS: OINODataRow[];
-/** Key-value collection */
-export type OINOValues = Record<string, string>;

package/src/OINODbDataSet.ts

@@ -1,167 +0,0 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-
-import { OINODataRow, OINO_ERROR_PREFIX, OINODB_EMPTY_ROW } 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 abstract class OINODbDataSet {
-    private _data: unknown;
-
-    /** 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[] = []) {
-        this._data = data;
-        this.messages = messages;
-    }
-
-    /**
-     * 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 {
-        for (let i=0; i<this.messages.length; i++) {
-            if (this.messages[i].startsWith(OINO_ERROR_PREFIX)) {
-                return true
-            }
-        }
-        return false
-    }
-    /**
-     * Checks if the messages contain errors.
-     * 
-     */
-    getFirstError(): string {
-        for (let i=0; i<this.messages.length; i++) {
-            if (this.messages[i].startsWith(OINO_ERROR_PREFIX)) {
-                return this.messages[i]
-            }
-        }
-        return ""
-    }
-}
-
-/**
- * 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 class OINODbMemoryDataSet extends OINODbDataSet {
-    private _rows: OINODataRow[];
-    private _currentRow: number;
-    private _eof: boolean;
-
-    /**
-     * 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[] = []) {
-        super(data, errors);
-        if ((data == null) || !(Array.isArray(data))) {
-            throw new Error(OINO_ERROR_PREFIX + ": Data needs to be compatible with OINORow[]!"); // TODO: maybe check all rows
-        }
-        this._rows = data as OINODataRow[];
-        if (this.isEmpty()) {
-            this._currentRow = -1;
-            this._eof = true;
-        } else {
-            this._currentRow = 0;
-            this._eof = false;
-        }
-    }
-
-    /**
-     * Is data set empty.
-     *
-     */
-    isEmpty(): boolean {
-        return (this._rows.length == 0);
-    }
-
-    /**
-     * Is there no more content, i.e. either dataset is empty or we have moved beyond last line
-     *
-     */
-    isEof(): boolean {
-        return (this._eof);
-    }
-
-    /**
-     * Attempts to moves dataset to the next row, possibly waiting for more data to become available. Returns !isEof().
-     *
-     */
-    async next(): Promise<boolean> {
-        if (this._currentRow < this._rows.length - 1) {
-            this._currentRow = this._currentRow + 1;
-        } else {
-            this._eof = true;
-        }
-        return Promise.resolve(!this._eof);
-    }
-
-    /**
-     * Gets current row of data.
-     *
-     */
-    getRow(): OINODataRow {
-        if ((this._currentRow >= 0) && (this._currentRow < this._rows.length)) {
-            return this._rows[this._currentRow];
-        } else {
-            return OINODB_EMPTY_ROW;
-        }
-    }
-
-    /**
-     * Rewinds data set to the first row, returns !isEof().
-     *
-     */
-    first(): boolean {
-        this._currentRow = 0;
-        this._eof = this._rows.length == 0;
-        return !this._eof;
-    }
-}