inibase 1.0.0-rc.10 → 1.0.0-rc.100

package/dist/index.d.ts

@@ -0,0 +1,193 @@
+import "dotenv/config";
+export interface Data {
+    id?: number | string;
+    [key: string]: any;
+    createdAt?: number;
+    updatedAt?: number;
+}
+export type FieldType = "string" | "number" | "boolean" | "date" | "email" | "url" | "table" | "object" | "array" | "password" | "html" | "ip" | "json" | "id";
+export type Field = {
+    id?: string | number;
+    key: string;
+    type: FieldType | FieldType[];
+    required?: boolean;
+    table?: string;
+    unique?: boolean;
+    children?: FieldType | FieldType[] | Schema;
+};
+export type Schema = Field[];
+export interface Options {
+    page?: number;
+    perPage?: number;
+    columns?: string[] | string;
+    sort?: Record<string, 1 | -1 | "asc" | "ASC" | "desc" | "DESC"> | string[] | string;
+}
+export interface Config {
+    compression?: boolean;
+    cache?: boolean;
+    prepend?: boolean;
+}
+export interface TableObject {
+    schema?: Schema;
+    config: Config;
+}
+export type ComparisonOperator = "=" | "!=" | ">" | "<" | ">=" | "<=" | "*" | "!*" | "[]" | "![]";
+export type pageInfo = {
+    total?: number;
+    totalPages?: number;
+} & Options;
+export type Criteria = ({
+    [logic in "and" | "or"]?: Criteria | (string | number | boolean | null)[];
+} & {
+    [key: string]: string | number | boolean | undefined | Criteria;
+}) | null;
+type Entries<T> = {
+    [K in keyof T]: [K, T[K]];
+}[keyof T][];
+declare global {
+    interface ObjectConstructor {
+        entries<T extends object>(o: T): Entries<T>;
+    }
+}
+export type ErrorCodes = "FIELD_UNIQUE" | "FIELD_REQUIRED" | "NO_SCHEMA" | "NO_ITEMS" | "INVALID_ID" | "INVALID_TYPE" | "INVALID_PARAMETERS" | "NO_ENV" | "TABLE_EXISTS" | "TABLE_NOT_EXISTS";
+export type ErrorLang = "en";
+export default class Inibase {
+    pageInfo: Record<string, pageInfo>;
+    salt: Buffer;
+    private databasePath;
+    private tables;
+    private fileExtension;
+    private checkIFunique;
+    private totalItems;
+    constructor(database: string, mainFolder?: string);
+    private Error;
+    private getFileExtension;
+    private _schemaToIdsPath;
+    /**
+     * Create a new table inside database, with predefined schema and config
+     *
+     * @param {string} tableName
+     * @param {Schema} [schema]
+     * @param {Config} [config]
+     */
+    createTable(tableName: string, schema?: Schema, config?: Config): Promise<void>;
+    private replaceStringInFile;
+    private replaceStringInSchemas;
+    /**
+     * Update table schema or config
+     *
+     * @param {string} tableName
+     * @param {Schema} [schema]
+     * @param {(Config&{name?: string})} [config]
+     */
+    updateTable(tableName: string, schema?: Schema, config?: Config & {
+        name?: string;
+    }): Promise<void>;
+    /**
+     * Get table schema and config
+     *
+     * @param {string} tableName
+     * @return {*}  {Promise<TableObject>}
+     */
+    getTable(tableName: string): Promise<TableObject>;
+    getTableSchema(tableName: string, encodeIDs?: boolean): Promise<Schema | undefined>;
+    private throwErrorIfTableEmpty;
+    private validateData;
+    private cleanObject;
+    private formatField;
+    private checkUnique;
+    private formatData;
+    private getDefaultValue;
+    private _combineObjectsToArray;
+    private _CombineData;
+    private joinPathesContents;
+    private _getItemsFromSchemaHelper;
+    private getItemsFromSchema;
+    private applyCriteria;
+    private _filterSchemaByColumns;
+    /**
+     * Clear table cache
+     *
+     * @param {string} tableName
+     */
+    clearCache(tableName: string): Promise<void>;
+    /**
+     * Retrieve item(s) from a table
+     *
+     * @param {string} tableName
+     * @param {(string | number | (string | number)[] | Criteria)} [where]
+     * @param {Options} [options]
+     * @param {boolean} [onlyOne]
+     * @param {boolean} [onlyLinesNumbers]
+     * @return {*}  {(Promise<Data | number | (Data | number)[] | null>)}
+     */
+    get(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers?: false): Promise<Data | null>;
+    get(tableName: string, where: string | number, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false): Promise<Data | null>;
+    get(tableName: string, where?: string | number | (string | number)[] | Criteria, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false): Promise<Data[] | null>;
+    get(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: false | undefined, onlyLinesNumbers: true): Promise<number[] | null>;
+    get(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers: true): Promise<number | null>;
+    /**
+     * Create new item(s) in a table
+     *
+     * @param {string} tableName
+     * @param {(Data | Data[])} data Can be array of objects or a single object
+     * @param {Options} [options] Pagination options, useful when the returnPostedData param is true
+     * @param {boolean} [returnPostedData] By default function returns void, if you want to get the posted data, set this param to true
+     * @return {*}  {Promise<Data | Data[] | null | void>}
+     */
+    post(tableName: string, data: Data | Data[], options?: Options, returnPostedData?: boolean): Promise<void>;
+    post(tableName: string, data: Data, options: Options | undefined, returnPostedData: true): Promise<Data | null>;
+    post(tableName: string, data: Data[], options: Options | undefined, returnPostedData: true): Promise<Data[] | null>;
+    /**
+     * Update item(s) in a table
+     *
+     * @param {string} tableName
+     * @param {(Data | Data[])} data
+     * @param {(number | string | (number | string)[] | Criteria)} [where]
+     * @param {Options} [options]
+     * @param {false} [returnUpdatedData]
+     * @return {*}  {Promise<Data | Data[] | null | undefined | void>}
+     */
+    put(tableName: string, data: Data | Data[], where?: number | string | (number | string)[] | Criteria, options?: Options, returnUpdatedData?: false): Promise<void>;
+    put(tableName: string, data: Data, where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true): Promise<Data | null>;
+    put(tableName: string, data: Data[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true): Promise<Data[] | null>;
+    /**
+     * Delete item(s) in a table
+     *
+     * @param {string} tableName
+     * @param {(number | string | (number | string)[] | Criteria)} [where]
+     * @return {boolean | null}  {(Promise<boolean | null>)}
+     */
+    delete(tableName: string, where?: number | string | (number | string)[] | Criteria, _id?: string | string[]): Promise<boolean | null>;
+    /**
+     * Generate sum of column(s) in a table
+     *
+     * @param {string} tableName
+     * @param {string} columns
+     * @param {(number | string | (number | string)[] | Criteria)} [where]
+     * @return {*}  {Promise<number | Record<string, number>>}
+     */
+    sum(tableName: string, columns: string, where?: number | string | (number | string)[] | Criteria): Promise<number>;
+    sum(tableName: string, columns: string[], where?: number | string | (number | string)[] | Criteria): Promise<Record<string, number>>;
+    /**
+     * Generate max of column(s) in a table
+     *
+     * @param {string} tableName
+     * @param {string} columns
+     * @param {(number | string | (number | string)[] | Criteria)} [where]
+     * @return {*}  {Promise<number>}
+     */
+    max(tableName: string, columns: string, where?: number | string | (number | string)[] | Criteria): Promise<number>;
+    max(tableName: string, columns: string[], where?: number | string | (number | string)[] | Criteria): Promise<Record<string, number>>;
+    /**
+     * Generate min of column(s) in a table
+     *
+     * @param {string} tableName
+     * @param {string} columns
+     * @param {(number | string | (number | string)[] | Criteria)} [where]
+     * @return {*}  {Promise<number>}
+     */
+    min(tableName: string, columns: string, where?: number | string | (number | string)[] | Criteria): Promise<number>;
+    min(tableName: string, columns: string[], where?: number | string | (number | string)[] | Criteria): Promise<Record<string, number>>;
+}
+export {};