@oino-ts/types 0.3.3 → 0.3.4

package/index.d.ts

@@ -1,23 +1,23 @@
-/// <reference path="db/src/index.d.ts
-/// <reference path="db/src/OINODb.d.ts
-/// <reference path="db/src/OINODbApi.d.ts
-/// <reference path="db/src/OINODbConfig.d.ts
-/// <reference path="db/src/OINODbDataField.d.ts
-/// <reference path="db/src/OINODbDataModel.d.ts
-/// <reference path="db/src/OINODbFactory.d.ts
-/// <reference path="db/src/OINODbModelSet.d.ts
-/// <reference path="db/src/OINODbRequestParams.d.ts
-/// <reference path="db/src/OINODbSqlParams.d.ts
-/// <reference path="db/src/OINODbSwagger.d.ts
-/// <reference path="db/src/OINODbParser.d.ts
-/// <reference path="db-bunsqlite/src/OINODbBunSqlite.d.ts
-/// <reference path="db-mariadb/src/OINODbMariadb.d.ts
-/// <reference path="db-mssql/src/OINODbMsSql.d.ts
-/// <reference path="db-postgresql/src/OINODbPostgresql.d.ts
-/// <reference path="hashid/src/OINOHashid.d.ts
-/// <reference path="common/src/index.d.ts
-/// <reference path="common/src/OINOBenchmark.d.ts
-/// <reference path="common/src/OINOHtmlTemplate.d.ts
-/// <reference path="common/src/OINOLog.d.ts
-/// <reference path="common/src/OINOResult.d.ts
-/// <reference path="common/src/OINOStr.d.ts
+/// <reference path="db/src/index.d.ts
+/// <reference path="db/src/OINODb.d.ts
+/// <reference path="db/src/OINODbApi.d.ts
+/// <reference path="db/src/OINODbConfig.d.ts
+/// <reference path="db/src/OINODbDataField.d.ts
+/// <reference path="db/src/OINODbDataModel.d.ts
+/// <reference path="db/src/OINODbFactory.d.ts
+/// <reference path="db/src/OINODbModelSet.d.ts
+/// <reference path="db/src/OINODbRequestParams.d.ts
+/// <reference path="db/src/OINODbSqlParams.d.ts
+/// <reference path="db/src/OINODbSwagger.d.ts
+/// <reference path="db/src/OINODbParser.d.ts
+/// <reference path="db-bunsqlite/src/OINODbBunSqlite.d.ts
+/// <reference path="db-mariadb/src/OINODbMariadb.d.ts
+/// <reference path="db-mssql/src/OINODbMsSql.d.ts
+/// <reference path="db-postgresql/src/OINODbPostgresql.d.ts
+/// <reference path="hashid/src/OINOHashid.d.ts
+/// <reference path="common/src/index.d.ts
+/// <reference path="common/src/OINOBenchmark.d.ts
+/// <reference path="common/src/OINOHtmlTemplate.d.ts
+/// <reference path="common/src/OINOLog.d.ts
+/// <reference path="common/src/OINOResult.d.ts
+/// <reference path="common/src/OINOStr.d.ts

package/package.json

@@ -1,26 +1,26 @@
-{
-  "name": "@oino-ts/types",
-  "version": "0.3.3",
-  "description": "OINO TS package for types.",
-  "author": "Matias Kiviniemi (pragmatta)",
-  "license": "MPL-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/pragmatta/oino-ts.git"
-  },
-  "keywords": [
-    "types",
-    "typescript",
-    "library"
-  ],
-  "main": "",
-  "types": "index.d.ts",
-  "dependencies": {
-  },
-  "devDependencies": {
-  },
-  "files": [
-    "index.d.ts",
-    "**/src/*.d.ts"
-  ]
-}
+{
+  "name": "@oino-ts/types",
+  "version": "0.3.4",
+  "description": "OINO TS package for types.",
+  "author": "Matias Kiviniemi (pragmatta)",
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pragmatta/oino-ts.git"
+  },
+  "keywords": [
+    "types",
+    "typescript",
+    "library"
+  ],
+  "main": "",
+  "types": "index.d.ts",
+  "dependencies": {
+  },
+  "devDependencies": {
+  },
+  "files": [
+    "index.d.ts",
+    "**/src/*.d.ts"
+  ]
+}

package/db/src/OINODb.d.ts

@@ -1,181 +0,0 @@
-import { OINODbParams, OINODbApi, OINODataCell, OINODataRow } from "./index.js";
-/**
- * Base class for database abstraction, implementing methods for connecting, making queries and parsing/formatting data
- * between SQL and serialization formats.
- *
- */
-export declare abstract class OINODb {
-    protected _params: OINODbParams;
-    /** Name of the database */
-    readonly name: string;
-    /**
-     * Constructor for `OINODb`.
-     * @param params database parameters
-     */
-    constructor(params: OINODbParams);
-    /**
-     * Connect to database.
-     *
-     */
-    abstract connect(): Promise<boolean>;
-    /**
-     * Print a table name using database specific SQL escaping.
-     *
-     * @param sqlTable name of the table
-     *
-     */
-    abstract printSqlTablename(sqlTable: string): string;
-    /**
-     * Print a column name with correct SQL escaping.
-     *
-     * @param sqlColumn name of the column
-     *
-     */
-    abstract printSqlColumnname(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 sqlType native type name for table column
-     *
-     */
-    abstract printCellAsSqlValue(cellValue: OINODataCell, sqlType: string): string;
-    /**
-     * Parse a single SQL result value for serialization using the context of the native data
-     * type.
-     *
-     * @param sqlValue data from serialization
-     * @param sqlType native type name for table column
-     *
-     */
-    abstract parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
-    /**
-     * Execute a select operation.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    abstract sqlSelect(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Execute other sql operations.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    abstract sqlExec(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
-     * the model.
-     *
-     * @param api api which data model to initialize.
-     *
-     */
-    abstract initializeApiDatamodel(api: OINODbApi): Promise<void>;
-    /**
-     * Print SQL select statement with DB specific formatting.
-     *
-     * @param tableName - The name of the table to select from.
-     * @param columnNames - The columns to be selected.
-     * @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, groupByCondition: string): string;
-}
-/**
- * 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/OINODbApi.d.ts

@@ -1,89 +0,0 @@
-import { OINODbApiParams, OINODb, OINODbDataModel, OINODataRow, OINODbModelSet, OINODbApiRequestParams, OINOHttpResult, OINOHtmlTemplate } from "./index.js";
-import { OINOResult } from "@oino-ts/common";
-import { OINOHashid } from "@oino-ts/hashid";
-/**
- * OINO API request result object with returned data and/or http status code/message and
- * error / warning messages.
- *
- */
-export declare class OINODbApiResult extends OINOResult {
-    /** DbApi request params */
-    params: OINODbApiRequestParams;
-    /** Returned data if any */
-    data?: OINODbModelSet;
-    /**
-     * Constructor of OINODbApiResult.
-     *
-     * @param params DbApi request parameters
-     * @param data result data
-     *
-     */
-    constructor(params: OINODbApiRequestParams, data?: OINODbModelSet);
-    /**
-     * Creates a HTTP Response from API results.
-     *
-     * @param headers Headers to include in the response
-     *
-     */
-    getResponse(headers?: Record<string, string>): Promise<Response>;
-}
-/**
- * Specialized HTML template that can render ´OINODbApiResult´.
- *
- */
-export declare class OINODbHtmlTemplate extends OINOHtmlTemplate {
-    /**
-     * Creates HTML Response from API modelset.
-     *
-     * @param modelset OINO API dataset
-     * @param overrideValues values to override in the data
-     *
-     */
-    renderFromDbData(modelset: OINODbModelSet, overrideValues?: any): Promise<OINOHttpResult>;
-}
-/**
- * API class with method to process HTTP REST requests.
- *
- */
-export declare class OINODbApi {
-    /** API database reference */
-    readonly db: OINODb;
-    /** API datamodel */
-    readonly datamodel: OINODbDataModel;
-    /** API parameters */
-    readonly params: OINODbApiParams;
-    /** API hashid */
-    readonly hashid: OINOHashid | null;
-    /**
-     * Constructor of API object.
-     * NOTE! OINODb.initDatamodel must be called if created manually instead of the factory.
-     *
-     * @param db database for the API
-     * @param params parameters for the API
-     *
-     */
-    constructor(db: OINODb, params: OINODbApiParams);
-    private _validateRowValues;
-    private _doGet;
-    private _doPost;
-    private _doPut;
-    private _doDelete;
-    /**
-     * Method for handlind a HTTP REST request with GET, POST, PUT, DELETE corresponding to
-     * SQL select, insert, update and delete.
-     *
-     * @param method HTTP verb (uppercase)
-     * @param id URL id of the REST request
-     * @param body HTTP body data as either serialized string or unserialized JS object / OINODataRow-array
-     * @param params HTTP URL parameters as key-value-pairs
-     *
-     */
-    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

@@ -1,54 +0,0 @@
-/** Set the name of the OINO ID field (default \_OINOID\_) */
-export declare class OINODbConfig {
-    /** Name of the synthetic OINO ID field */
-    static OINODB_ID_FIELD: string;
-    /** Private key separator of the synthetic OINO ID field */
-    static OINODB_ID_SEPARATOR: string;
-    private static OINODB_ID_SEPARATOR_ESCAPED;
-    /** Name of the OINODbSqlFilter-parameter in request */
-    static OINODB_SQL_FILTER_PARAM: string;
-    /** Name of the OINODbSqlOrder-parameter in request */
-    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
-     */
-    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;
-    /**
-     * Set the name of the OINODbSqlFilter-param field
-     *
-     * @param sqlFilterParam name of the http parameter with `OINODbSqlFilter` definition
-     *
-     */
-    static setOinoSqlFilterParam(sqlFilterParam: string): void;
-    /**
-     * Set the name of the OINODbSqlOrder-param field
-     *
-     * @param sqlOrderParam name of the http parameter with `OINODbSqlOrder` definition
-     *
-     */
-    static setOinoSqlOrderParam(sqlOrderParam: string): void;
-    /**
-     * Set the name of the OINODbSqlLimit-param field
-     *
-     * @param sqlLimitParam name of the http parameter with `OINODbSqlLimit` definition
-     *
-     */
-    static setOinoSqlLimitParam(sqlLimitParam: string): void;
-}

package/db/src/OINODbDataField.d.ts

@@ -1,202 +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;
-    /**
-     * Parce cell value from string using field type specific formatting rules.
-     *
-     * @param value string value
-     *
-     */
-    deserializeCell(value: string | null | undefined): OINODataCell;
-}