inibase 1.0.0-rc.4 → 1.0.0-rc.42

package/dist/index.d.ts

@@ -0,0 +1,111 @@
+/// <reference types="node" resolution-mode="require"/>
+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";
+type FieldDefault = {
+    id?: string | number;
+    key: string;
+    required?: boolean;
+};
+type FieldStringType = {
+    type: Exclude<FieldType, "array" | "object">;
+    children?: never;
+};
+type FieldStringArrayType = {
+    type: Array<Exclude<FieldType, "object">>;
+    children?: never;
+};
+type FieldArrayType = {
+    type: "array";
+    children: Exclude<FieldType, "array"> | Array<Exclude<FieldType, "array">> | Schema;
+};
+type FieldArrayArrayType = {
+    type: Array<"array" | Exclude<FieldType, "array" | "object">>;
+    children: Exclude<FieldType, "array" | "object"> | Array<Exclude<FieldType, "array" | "object">>;
+};
+type FieldObjectType = {
+    type: "object";
+    children: Schema;
+};
+export type Field = FieldDefault & (FieldStringType | FieldStringArrayType | FieldArrayArrayType | FieldObjectType | FieldArrayType);
+export type Schema = Field[];
+export interface Options {
+    page?: number;
+    perPage?: number;
+    columns?: string[] | string;
+    order?: Record<string, "asc" | "desc">;
+}
+export type ComparisonOperator = "=" | "!=" | ">" | "<" | ">=" | "<=" | "*" | "!*" | "[]" | "![]";
+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;
+declare global {
+    type Entries<T> = {
+        [K in keyof T]: [K, T[K]];
+    }[keyof T][];
+    interface ObjectConstructor {
+        entries<T extends object>(o: T): Entries<T>;
+    }
+}
+export type ErrorCodes = "FIELD_REQUIRED" | "NO_SCHEMA" | "NO_ITEMS" | "NO_RESULTS" | "INVALID_ID" | "INVALID_TYPE" | "INVALID_PARAMETERS";
+export type ErrorLang = "en";
+export default class Inibase {
+    folder: string;
+    database: string;
+    table: string | null;
+    pageInfo: Record<string, pageInfo>;
+    private isThreadEnabled;
+    private totalItems;
+    salt: Buffer;
+    constructor(database: string, mainFolder?: string, _table?: string | null, _totalItems?: Record<string, number>, _pageInfo?: Record<string, pageInfo>, _isThreadEnabled?: boolean);
+    private throwError;
+    createWorker(functionName: "get" | "post" | "put" | "delete" | "sum" | "min" | "max" | "sort", arg: any[]): Promise<any>;
+    private _decodeIdFromSchema;
+    private _schemaToIdsPath;
+    setTableSchema(tableName: string, schema: Schema): Promise<void>;
+    getTableSchema(tableName: string): Promise<Schema | undefined>;
+    isTableEmpty(tableName: string): Promise<never | Schema>;
+    getField(keyPath: string, schema: Schema): Field | null;
+    private validateData;
+    private formatField;
+    private formatData;
+    private getDefaultValue;
+    private _combineObjectsToArray;
+    private _CombineData;
+    private _addPathToKeys;
+    joinPathesContents(mainPath: string, data: Data | Data[]): {
+        [key: string]: string[];
+    };
+    private getItemsFromSchema;
+    private applyCriteria;
+    private _filterSchemaByColumns;
+    clearCache(tablePath: string): Promise<void>;
+    get(tableName: string, where?: string | number | (string | number)[] | Criteria | undefined, options?: Options | undefined, onlyOne?: true, onlyLinesNumbers?: undefined, tableSchema?: Schema, skipIdColumn?: boolean): Promise<Data | null>;
+    get(tableName: string, where?: string | number | (string | number)[] | Criteria | undefined, options?: Options | undefined, onlyOne?: boolean | undefined, onlyLinesNumbers?: true, tableSchema?: Schema, skipIdColumn?: boolean): Promise<number[]>;
+    post(tableName: string, data: Data | Data[], options?: Options, returnPostedData?: boolean): Promise<void | null>;
+    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>;
+    put(tableName: string, data: Data | Data[], where?: number | string | (number | string)[] | Criteria, options?: Options, returnPostedData?: false): Promise<void | null>;
+    put(tableName: string, data: Data, where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnPostedData: true): Promise<Data | null>;
+    put(tableName: string, data: Data[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnPostedData: true): Promise<Data[] | null>;
+    delete(tableName: string, where?: number | string, _id?: string | string[]): Promise<string | null>;
+    delete(tableName: string, where?: (number | string)[] | Criteria, _id?: string | string[]): Promise<string[] | null>;
+    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>>;
+    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>>;
+    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>>;
+    sort(tableName: string, columns: string | string[] | Record<string, 1 | -1 | "asc" | "ASC" | "desc" | "DESC">, where?: string | number | (string | number)[] | Criteria, options?: Options): Promise<any[]>;
+}
+export {};