mirror of
https://github.com/frappe/books.git
synced 2024-12-23 19:39:07 +00:00
2a5686058d
- fix db where clauses
96 lines
2.4 KiB
TypeScript
96 lines
2.4 KiB
TypeScript
/**
|
|
* The types in this file will be used by the main db class (core.ts) in the
|
|
* backend process and the the frontend db class (dbHandler.ts).
|
|
*
|
|
* DatabaseBase is an abstract class so that the function signatures
|
|
* match on both ends i.e. DatabaseCore and DatabaseHandler.
|
|
*/
|
|
|
|
import { SchemaMap } from 'schemas/types';
|
|
|
|
type UnknownMap = Record<string, unknown>;
|
|
export abstract class DatabaseBase {
|
|
// Create
|
|
abstract insert(
|
|
schemaName: string,
|
|
fieldValueMap: UnknownMap
|
|
): Promise<UnknownMap>;
|
|
|
|
// Read
|
|
abstract get(
|
|
schemaName: string,
|
|
name: string,
|
|
fields?: string | string[]
|
|
): Promise<UnknownMap>;
|
|
|
|
abstract getAll(
|
|
schemaName: string,
|
|
options: GetAllOptions
|
|
): Promise<UnknownMap[]>;
|
|
|
|
abstract getSingleValues(
|
|
...fieldnames: ({ fieldname: string; parent?: string } | string)[]
|
|
): Promise<{ fieldname: string; parent: string; value: unknown }[]>;
|
|
|
|
// Update
|
|
abstract rename(
|
|
schemaName: string,
|
|
oldName: string,
|
|
newName: string
|
|
): Promise<void>;
|
|
|
|
abstract update(schemaName: string, fieldValueMap: UnknownMap): Promise<void>;
|
|
|
|
// Delete
|
|
abstract delete(schemaName: string, name: string): Promise<void>;
|
|
|
|
abstract deleteAll(schemaName:string, filters:QueryFilter): Promise<number>;
|
|
|
|
// Other
|
|
abstract close(): Promise<void>;
|
|
|
|
abstract exists(schemaName: string, name?: string): Promise<boolean>;
|
|
}
|
|
|
|
export type DatabaseMethod = keyof DatabaseBase;
|
|
|
|
export interface GetAllOptions {
|
|
fields?: string[];
|
|
filters?: QueryFilter;
|
|
offset?: number;
|
|
limit?: number;
|
|
groupBy?: string;
|
|
orderBy?: string;
|
|
order?: 'asc' | 'desc';
|
|
}
|
|
|
|
export type QueryFilter = Record<
|
|
string,
|
|
boolean | string | null | (string | number | (string | number | null)[])[]
|
|
>;
|
|
|
|
/**
|
|
* DatabaseDemuxBase is an abstract class that ensures that the function signatures
|
|
* match between the DatabaseManager and the DatabaseDemux.
|
|
*
|
|
* This allows testing the frontend code while directly plugging in the DatabaseManager
|
|
* and bypassing all the API and IPC calls.
|
|
*/
|
|
export abstract class DatabaseDemuxBase {
|
|
abstract getSchemaMap(): Promise<SchemaMap> | SchemaMap;
|
|
|
|
abstract createNewDatabase(
|
|
dbPath: string,
|
|
countryCode: string
|
|
): Promise<string>;
|
|
|
|
abstract connectToDatabase(
|
|
dbPath: string,
|
|
countryCode?: string
|
|
): Promise<string>;
|
|
|
|
abstract call(method: DatabaseMethod, ...args: unknown[]): Promise<unknown>;
|
|
|
|
abstract callBespoke(method: string, ...args: unknown[]): Promise<unknown>;
|
|
}
|