@oino-ts/types 0.3.3 → 0.4.0

package/db/src/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/db/src/index.d.ts

@@ -1,117 +0,0 @@
-import { OINOContentType } from "@oino-ts/common";
-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/common";
-import { OINODb } from "./OINODb.js";
-import { OINODbDataField } from "./OINODbDataField.js";
-import { OINODbSqlAggregate, OINODbSqlFilter, OINODbSqlLimit, OINODbSqlOrder } from "./OINODbSqlParams.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 { OINODbDataSet, OINODbMemoryDataSet, OINODb } from "./OINODb.js";
-export { OINODbSqlFilter, OINODbSqlOrder, OINODbSqlComparison, OINODbSqlLimit, OINODbSqlBooleanOperation, OINODbSqlAggregate, OINODbSqlAggregateFunctions } from "./OINODbSqlParams.js";
-export { OINODbConfig } from "./OINODbConfig.js";
-export { OINODbFactory } from "./OINODbFactory.js";
-export { OINODbSwagger } from "./OINODbSwagger.js";
-export { OINODbParser } from "./OINODbParser.js";
-/** API parameters */
-export type OINODbApiParams = {
-    /** 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;
-    /** 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;
-};
-/**
- * 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;
-    /** SQL aggregation functions */
-    aggregate?: OINODbSqlAggregate;
-};
-/** 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/db-bunsqlite/src/OINODbBunSqlite.d.ts

@@ -1,77 +0,0 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } 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
-     *
-     */
-    printSqlTablename(sqlTable: string): string;
-    /**
-     * Print a column name with correct SQL escaping.
-     *
-     * @param sqlColumn name of the column
-     *
-     */
-    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
-     *
-     */
-    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
-     *
-     */
-    parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
-    /**
-     * Connect to database.
-     *
-     */
-    connect(): Promise<boolean>;
-    /**
-     * Execute a select operation.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlSelect(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Execute other sql operations.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    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.
-     *
-     */
-    initializeApiDatamodel(api: OINODbApi): Promise<void>;
-}

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

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

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

@@ -1,78 +0,0 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
-/**
- * Implementation of MariaDb/MySql-database.
- *
- */
-export declare class OINODbMariadb extends OINODb {
-    private static _fieldLengthRegex;
-    private static _exceptionMessageRegex;
-    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
-     *
-     */
-    printSqlTablename(sqlTable: string): string;
-    /**
-     * Print a column name with correct SQL escaping.
-     *
-     * @param sqlColumn name of the column
-     *
-     */
-    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
-     *
-     */
-    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
-     *
-     */
-    parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
-    /**
-     * Connect to database.
-     *
-     */
-    connect(): Promise<boolean>;
-    /**
-     * Execute a select operation.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlSelect(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Execute other sql operations.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlExec(sql: string): Promise<OINODbDataSet>;
-    private _getSchemaSql;
-    /**
-     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
-     * the model.
-     *
-     * @param api api which data model to initialize.
-     *
-     */
-    initializeApiDatamodel(api: OINODbApi): Promise<void>;
-}

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

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

package/db-mssql/src/OINODbMsSql.d.ts

@@ -1,87 +0,0 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
-/**
- * Implementation of MariaDb/MySql-database.
- *
- */
-export declare class OINODbMsSql extends OINODb {
-    private _pool;
-    /**
-     * Constructor of `OINODbMsSql`
-     * @param params database parameters
-     */
-    constructor(params: OINODbParams);
-    private _query;
-    private _exec;
-    /**
-     * Print a table name using database specific SQL escaping.
-     *
-     * @param sqlTable name of the table
-     *
-     */
-    printSqlTablename(sqlTable: string): string;
-    /**
-     * Print a column name with correct SQL escaping.
-     *
-     * @param sqlColumn name of the column
-     *
-     */
-    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
-     *
-     */
-    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
-     *
-     */
-    parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
-    /**
-     * 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;
-    /**
-     * Connect to database.
-     *
-     */
-    connect(): Promise<boolean>;
-    /**
-     * Execute a select operation.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlSelect(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Execute other sql operations.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlExec(sql: string): Promise<OINODbDataSet>;
-    private _getSchemaSql;
-    /**
-     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
-     * the model.
-     *
-     * @param api api which data model to initialize.
-     *
-     */
-    initializeApiDatamodel(api: OINODbApi): Promise<void>;
-}

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

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

package/db-postgresql/src/OINODbPostgresql.d.ts

@@ -1,76 +0,0 @@
-import { OINODb, OINODbParams, OINODbDataSet, OINODbApi, OINODataCell } from "@oino-ts/db";
-/**
- * Implementation of Postgresql-database.
- *
- */
-export declare class OINODbPostgresql extends OINODb {
-    private _pool;
-    /**
-     * Constructor of `OINODbPostgresql`
-     * @param params database paraneters
-     */
-    constructor(params: OINODbParams);
-    private _parseFieldLength;
-    private _query;
-    private _exec;
-    /**
-     * Print a table name using database specific SQL escaping.
-     *
-     * @param sqlTable name of the table
-     *
-     */
-    printSqlTablename(sqlTable: string): string;
-    /**
-     * Print a column name with correct SQL escaping.
-     *
-     * @param sqlColumn name of the column
-     *
-     */
-    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
-     *
-     */
-    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
-     *
-     */
-    parseSqlValueAsCell(sqlValue: OINODataCell, sqlType: string): OINODataCell;
-    /**
-     * Connect to database.
-     *
-     */
-    connect(): Promise<boolean>;
-    /**
-     * Execute a select operation.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlSelect(sql: string): Promise<OINODbDataSet>;
-    /**
-     * Execute other sql operations.
-     *
-     * @param sql SQL statement.
-     *
-     */
-    sqlExec(sql: string): Promise<OINODbDataSet>;
-    private _getSchemaSql;
-    /**
-     * Initialize a data model by getting the SQL schema and populating OINODbDataFields of
-     * the model.
-     *
-     * @param api api which data model to initialize.
-     *
-     */
-    initializeApiDatamodel(api: OINODbApi): Promise<void>;
-}

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

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

package/hashid/src/OINOHashid.d.ts

@@ -1,42 +0,0 @@
-export declare const OINOHASHID_MIN_LENGTH: number;
-export declare const OINOHASHID_MAX_LENGTH: number;
-/**
- * Hashid implementation for OINO API:s for the purpose of making it infeasible to scan
- * through numeric autoinc keys. It's not a solution to keeping the id secret in insecure
- * channels, just making it hard enough to not iterate through the entire key space. Half
- * of the the hashid length is nonce and half cryptotext, i.e. 16 char hashid 8 chars of
- * base64 encoded nonce ~ 6 bytes or 48 bits of entropy.
- *
- */
-export declare class OINOHashid {
-    private _key;
-    private _iv;
-    private _domainId;
-    private _minLength;
-    private _staticIds;
-    /**
-     * Hashid constructor
-     *
-     * @param key AES128 key (32 char hex-string)
-     * @param domainId a sufficiently unique domain ID in which row-Id's are unique
-     * @param minLength minimum length of nonce and crypto
-     * @param staticIds whether hash values should remain static per row or random values
-     *
-     */
-    constructor(key: string, domainId: string, minLength?: number, staticIds?: boolean);
-    /**
-     * Encode given id value as a hashid either using random data or given seed value for nonce.
-     *
-     * @param id numeric value
-     * @param cellSeed a sufficiently unique seed for the current cell to keep hashids unique but persistent (e.g. fieldname + primarykey values)
-     *
-     */
-    encode(id: string, cellSeed?: string): string;
-    /**
-     * Decode given hashid.
-     *
-     * @param hashid value
-     *
-     */
-    decode(hashid: string): string;
-}

package/hashid/src/index.d.ts

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