inibase 1.0.0-rc.99 → 1.1.0

package/dist/index.d.ts

@@ -12,8 +12,9 @@ export type Field = {
     type: FieldType | FieldType[];
     required?: boolean;
     table?: string;
-    unique?: boolean;
+    unique?: boolean | number | string;
     children?: FieldType | FieldType[] | Schema;
+    regex?: string;
 };
 export type Schema = Field[];
 export interface Options {
@@ -49,18 +50,20 @@ declare global {
         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 ErrorCodes = "FIELD_UNIQUE" | "FIELD_REQUIRED" | "NO_SCHEMA" | "TABLE_EMPTY" | "INVALID_ID" | "INVALID_TYPE" | "INVALID_PARAMETERS" | "NO_ENV" | "TABLE_EXISTS" | "TABLE_NOT_EXISTS" | "INVALID_REGEX_MATCH";
 export type ErrorLang = "en";
 export default class Inibase {
     pageInfo: Record<string, pageInfo>;
     salt: Buffer;
     private databasePath;
-    private tables;
     private fileExtension;
-    private checkIFunique;
+    private tablesMap;
+    private uniqueMap;
     private totalItems;
     constructor(database: string, mainFolder?: string);
-    private Error;
+    private static errorMessages;
+    createError(name: ErrorCodes, variable?: string | number | (string | number)[], language?: ErrorLang): Error;
+    clear(): void;
     private getFileExtension;
     private _schemaToIdsPath;
     /**
@@ -72,7 +75,6 @@ export default class Inibase {
      */
     createTable(tableName: string, schema?: Schema, config?: Config): Promise<void>;
     private replaceStringInFile;
-    private replaceStringInSchemas;
     /**
      * Update table schema or config
      *
@@ -89,9 +91,10 @@ export default class Inibase {
      * @param {string} tableName
      * @return {*}  {Promise<TableObject>}
      */
-    getTable(tableName: string): Promise<TableObject>;
+    getTable(tableName: string, encodeIDs?: boolean): Promise<TableObject>;
     getTableSchema(tableName: string, encodeIDs?: boolean): Promise<Schema | undefined>;
     private throwErrorIfTableEmpty;
+    private _validateData;
     private validateData;
     private cleanObject;
     private formatField;
@@ -101,8 +104,17 @@ export default class Inibase {
     private _combineObjectsToArray;
     private _CombineData;
     private joinPathesContents;
-    private _getItemsFromSchemaHelper;
-    private getItemsFromSchema;
+    private _processSchemaDataHelper;
+    private processSchemaData;
+    private isSimpleField;
+    private processSimpleField;
+    private isArrayField;
+    private processArrayField;
+    private isObjectField;
+    private processObjectField;
+    private isTableField;
+    private processTableField;
+    private _setNestedKey;
     private applyCriteria;
     private _filterSchemaByColumns;
     /**
@@ -121,36 +133,37 @@ export default class Inibase {
      * @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>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: true, onlyLinesNumbers?: false): Promise<(Data & TData) | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false): Promise<(Data & TData) | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where?: string | number | (string | number)[] | Criteria, options?: Options, onlyOne?: boolean, onlyLinesNumbers?: false): Promise<(Data & TData)[] | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(tableName: string, where: string | number | (string | number)[] | Criteria | undefined, options: Options | undefined, onlyOne: false | undefined, onlyLinesNumbers: true): Promise<number[] | null>;
+    get<TData extends Record<string, any> & Partial<Data>>(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 {((Data & TData) | (Data & TData)[])} 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>;
+    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData) | (Data & TData)[], options?: Options, returnPostedData?: boolean): Promise<void>;
+    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, options: Options | undefined, returnPostedData: true): Promise<(Data & TData) | null>;
+    post<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], options: Options | undefined, returnPostedData: true): Promise<(Data & TData)[] | null>;
     /**
      * Update item(s) in a table
      *
      * @param {string} tableName
-     * @param {(Data | Data[])} data
+     * @param {(Data & TData) | (Data & TData[])} data
      * @param {(number | string | (number | string)[] | Criteria)} [where]
      * @param {Options} [options]
-     * @param {false} [returnUpdatedData]
+     * @param {boolean} [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>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data?: (Data & TData) | (Data & TData)[], where?: number | string | (number | string)[] | Criteria | undefined, options?: Options | undefined, returnUpdatedData?: false): Promise<void>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: Data & TData, where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean): Promise<(Data & TData) | null>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData)[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean): Promise<(Data & TData)[] | null>;
+    put<TData extends Record<string, any> & Partial<Data>>(tableName: string, data: (Data & TData) | (Data & TData)[], where: number | string | (number | string)[] | Criteria | undefined, options: Options | undefined, returnUpdatedData: true | boolean): Promise<(Data & TData) | (Data & TData)[] | null>;
     /**
      * Delete item(s) in a table
      *