@trust0/ridb-core 1.7.26 → 1.7.27

package/build/ridb_core.d.ts

@@ -73,150 +73,199 @@ declare enum Errors {
   AuthenticationError = 5,
 }
 
-declare class CoreStorage {
+/**
+ * Represents a property within a schema, including various constraints and nested properties.
+ */
+declare class Property {
     /**
-    * @param {any} document
-    * @param {Query} query
-    * @returns {boolean}
-    */
-    matchesQuery(document: any, query: Query<any>): boolean;
-    getPrimaryKeyTyped(value: any): string | number;
-    getIndexes(schema: Schema<any>, op: Operation): string[];
-}
+     * The type of the property.
+     */
+    readonly type: SchemaFieldType;
 
+    /**
+     * The version of the property, if applicable.
+     */
+    readonly version?: number;
 
+    /**
+     * The primary key of the property, if applicable.
+     */
+    readonly primaryKey?: string;
 
-/**
- * Represents a database containing collections of documents.
- * RIDB extends from this class and is used to expose collections.
- * 
- * So if you specify:
- * ```typescript
- * const db = new RIDB(
- *     {
- *         schemas: {
- *             demo: {
- *                 version: 0,
- *                 primaryKey: 'id',
- *                 type: SchemaFieldType.object,
- *                 properties: {
- *                     id: {
- *                         type: SchemaFieldType.string,
- *                         maxLength: 60
- *                     }
- *                 }
- *             }
- *         } as const
- *     }
- * )
- * ```
- * 
- * The collection will be available as `db.collections.demo` and all the methods for the collection (find, count, findById, update, create, delete) will be available.
- *
- * @template T - A record of schema types.
- */
-declare class Database<T extends SchemaTypeRecord> {
+    /**
+     * An optional array of nested properties for array-type properties.
+     */
+    readonly items?: Property;
 
     /**
-     * Creates a new `Database` instance with the provided schemas and storage module.
-     *
-     * @template TS - A record of schema types.
-     * @param {TS} schemas - The schemas to use for the collections.
-     * @param migrations
-     * @param plugins
-     * @param options
-     * @param password
-     * @returns {Promise<Database<TS>>} A promise that resolves to the created `Database` instance.
+     * The maximum number of items for array-type properties, if applicable.
      */
-    static create<TS extends SchemaTypeRecord>(
-        db_name: string,
-        schemas: TS,
-        migrations: MigrationPathsForSchemas<TS> | MigrationPathsForSchema<TS[string]>,
-        plugins:Array<typeof BasePlugin>,
-        options: RIDBModule,
-        password?:string,
-        storage?: BaseStorage<TS>
-    ): Promise<Database<TS>>;
+    readonly maxItems?: number;
 
-    authenticate(password: string): Promise<boolean>;
+    /**
+     * The minimum number of items for array-type properties, if applicable.
+     */
+    readonly minItems?: number;
 
     /**
-     * The collections in the database.
-     *
-     * This is a read-only property where the key is the name of the collection and the value is a `Collection` instance.
+     * The maximum length for string-type properties, if applicable.
      */
-    readonly collections: {
-        [name in keyof T]: Collection<Schema<T[name]>>
-    }
+    readonly maxLength?: number;
 
-    readonly started: boolean;
+    /**
+     * The minimum length for string-type properties, if applicable.
+     */
+    readonly minLength?: number;
 
     /**
-     * Starts the database.
-     *
-     * @returns {Promise<void>} A promise that resolves when the database is started.
+     * An optional array of required fields for object-type properties.
      */
-    start(): Promise<void>;
+    readonly required?: boolean;
 
     /**
-     * Closes the database.
-     *
-     * @returns {Promise<void>} A promise that resolves when the database is closed.
+     * An optional default value for the property.
      */
-    close(): Promise<void>;
+    readonly default?: any;
+
+    /**
+     * An optional map of nested properties for object-type properties.
+     */
+    readonly properties?: {
+        [name: string]: Property;
+    };
 }
 
-/**
- * Represents a function type for creating storage with the provided schema type records.
- *
- * @template T - The schema type record.
- * @param {T} records - The schema type records.
- * @returns {Promise<InternalsRecord>} A promise that resolves to the created internals record.
- */
-type CreateStorage = <T extends SchemaTypeRecord>(
-    records: T
-) => Promise<BaseStorage<T>>;
+
 
 /**
- * Represents a storage module with a method for creating storage.
+ * Represents an IndexDB storage system extending the base storage functionality.
+ *
+ * @template T - The schema type.
  */
-type RIDBModule = {
-
+declare class IndexDB<T extends SchemaTypeRecord> extends BaseStorage<T> {
     /**
-     * Plugin constructors array
+     * Frees the resources used by the in-memory storage.
      */
-    apply: (plugins:Array<typeof BasePlugin>) => Array<BasePlugin>;
-};
+    free(): void;
+
+    static create<SchemasCreate extends SchemaTypeRecord>(
+        dbName: string,
+        schemas: SchemasCreate,
+    ): Promise<
+        IndexDB<
+            SchemasCreate
+        >
+    >;
+}
 
 
 
 /**
- * Represents an operation to be performed on a collection.
+ * Represents an in-memory storage system extending the base storage functionality.
  *
- * @template T - The schema type of the collection.
+ * @template T - The schema type.
  */
-type Operation<T extends SchemaType = SchemaType> = {
+declare class InMemory<T extends SchemaTypeRecord> extends BaseStorage<T> {
     /**
-     * The name of the collection on which the operation will be performed.
+     * Frees the resources used by the in-memory storage.
      */
-    collection: string,
+    free(): void;
 
-    /**
-     * The type of operation to be performed (e.g., CREATE, UPDATE, DELETE).
-     */
-    opType: OpType,
+    static create<SchemasCreate extends SchemaTypeRecord>(
+        dbName: string,
+        schemas: SchemasCreate,
+    ): Promise<
+        InMemory<
+            SchemasCreate
+        >
+    >;
+}
 
-    /**
-     * The data involved in the operation, conforming to the schema type.
-     */
-    data: Doc<T>,
 
-    primaryKeyField?: string,
-    primaryKey?: string
+
+type Hook = (
+    schema: Schema<SchemaType>,
+    migration: MigrationPathsForSchema<SchemaType>,
+    doc: Doc<SchemaType>
+) => Doc<SchemaType>
+
+type BasePluginOptions = {
+    docCreateHook?: Hook,
+    docRecoverHook?: Hook
+}
+
+declare class BasePlugin implements BasePluginOptions {
+     docCreateHook?:Hook;
+     docRecoverHook?:Hook;
 }
 
 
 
+type Operators<T> = {
+    $gte?: number,
+    $gt?: number
+    $lt?: number,
+    $lte?: number,
+    $eq?: T,
+    $ne?: T
+};
+
+type InOperator<T> = {  $in?: T[] };
+type NInOperator<T> = {  $nin?: T[] };
+
+type OperatorOrType<T> = T extends number ? 
+    T | Operators<T> | InOperator<T> | NInOperator<T> : 
+    T | InOperator<T> | NInOperator<T>;
+
+type LogicalOperators<T extends SchemaType> = {
+    $and?: Partial<QueryType<T>>[];
+    $or?: Partial<QueryType<T>>[];
+};
+
+type QueryType<T extends SchemaType> = ({
+    [K in keyof T['properties']as ExtractType<T['properties'][K]['type']> extends undefined ? never : K]?: OperatorOrType<
+        ExtractType<
+            T['properties'][K]['type']
+        >
+    >
+} & LogicalOperators<T>) | LogicalOperators<T>[];
+
+declare class Query<T extends SchemaType> {
+    constructor(query: QueryType<T>, schema:Schema<T>);
+    readonly query: QueryType<T>;
+}
+
+
+
+declare const SchemaFieldType = {
+  /**
+   * String type for text data
+   */
+  string: 'string' as const,
+  
+  /**
+   * Number type for numeric data (integers and floats)
+   */
+  number: 'number' as const,
+  
+  /**
+   * Boolean type for true/false values
+   */
+  boolean: 'boolean' as const,
+  
+  /**
+   * Array type for ordered collections of items
+   */
+  array: 'array' as const,
+  
+  /**
+   * Object type for nested document structures
+   */
+  object: 'object' as const,
+};
+
+
+
 type InternalsRecord = {
     [name: string]: BaseStorage<SchemaTypeRecord>
 };
@@ -336,302 +385,147 @@ declare class Collection<T extends SchemaType> {
 
 
 
-type BaseStorageOptions =  {
-    [name:string]:string | boolean | number
-}
-
-declare class BaseStorage<Schemas extends SchemaTypeRecord> extends StorageInternal<Schemas> {
-    static create<SchemasCreate extends SchemaTypeRecord>(
-        dbName: string,
-        schemas: SchemasCreate,
-        options?: BaseStorageOptions
-    ): Promise<
-        BaseStorage<
-            SchemasCreate
-        >
-    >;
-    constructor(
-        dbName: string, 
-        schemas: Schemas, 
-        options?: BaseStorageOptions
-    );
-    readonly dbName: string;
-    readonly schemas: Record<keyof Schemas, Schema<Schemas[keyof Schemas]>>;
-    readonly options: BaseStorageOptions;
-    readonly core: CoreStorage;
-    start(): Promise<void>;
-    close(): Promise<void>;
-    count(colectionName: keyof Schemas, query: QueryType<Schemas[keyof Schemas]>, options?: QueryOptions): Promise<number>;
-    findDocumentById(collectionName: keyof Schemas, id: string): Promise<Doc<Schemas[keyof Schemas]> | null>;
-    find(collectionName: keyof Schemas, query: QueryType<Schemas[keyof Schemas]>, options?: QueryOptions): Promise<Doc<Schemas[keyof Schemas]>[]>;
-    write(op: Operation<Schemas[keyof Schemas]>): Promise<Doc<Schemas[keyof Schemas]>>;
-    getOption(name: string): string | boolean | number | undefined;
-    getSchema(name: string): Schema<any>;
-    //Call addIndexSchemas if you need extra indexing schemas for your database
-    addIndexSchemas(): null
-}
-
-
-
-type Operators<T> = {
-    $gte?: number,
-    $gt?: number
-    $lt?: number,
-    $lte?: number,
-    $eq?: T,
-    $ne?: T
-};
-
-type InOperator<T> = {  $in?: T[] };
-type NInOperator<T> = {  $nin?: T[] };
-
-type OperatorOrType<T> = T extends number ? 
-    T | Operators<T> | InOperator<T> | NInOperator<T> : 
-    T | InOperator<T> | NInOperator<T>;
-
-type LogicalOperators<T extends SchemaType> = {
-    $and?: Partial<QueryType<T>>[];
-    $or?: Partial<QueryType<T>>[];
-};
-
-type QueryType<T extends SchemaType> = ({
-    [K in keyof T['properties']as ExtractType<T['properties'][K]['type']> extends undefined ? never : K]?: OperatorOrType<
-        ExtractType<
-            T['properties'][K]['type']
-        >
-    >
-} & LogicalOperators<T>) | LogicalOperators<T>[];
-
-declare class Query<T extends SchemaType> {
-    constructor(query: QueryType<T>, schema:Schema<T>);
-    readonly query: QueryType<T>;
-}
-
-
-
-/**
- * Represents the type definition for a schema.
- */
-type SchemaType = {
-    /**
-     * The version of the schema.
-     */
-     version: number;
-
+declare class CoreStorage {
     /**
-     * The primary key of the schema.
-     */
-     primaryKey: string;
+    * @param {any} document
+    * @param {Query} query
+    * @returns {boolean}
+    */
+    matchesQuery(document: any, query: Query<any>): boolean;
+    getPrimaryKeyTyped(value: any): string | number;
+    getIndexes(schema: Schema<any>, op: Operation): string[];
+}
 
-    /**
-     * The type of the schema.
-     */
-     type: SchemaFieldType;
-     indexes?:  string[];
-     encrypted?:  string[];
-    /**
-     * The properties defined in the schema.
-     */
-     properties: {
-        [name: string]: Property;
-    };
-};
 
 
 /**
- * Represents a schema, including its definition and related methods.
- * You may be trying to build a storage, in any other can u won't need access tho this class.
- * Check this example 
- * 
- * ```typescript
- * class MyStorage extends <T extends SchemaTypeRecord> extends BaseStorage<T> {
- *  example() {
- *    const schema: Schema<any> = this.getSchema("mySchema")
- *  }
- * }
- * ```
- * You alwayswill have access to getSchema through the Storage class.
- * 
- * @template T - The schema type.
+ * Represents an operation to be performed on a collection.
+ *
+ * @template T - The schema type of the collection.
  */
-declare class Schema<T extends SchemaType> {
-    /**
-     * The schema definition.
-     */
-    schema: Schema<T>;
-
-    /**
-     * Creates a new `Schema` instance from the provided definition.
-     *
-     * @template TS - The schema type.
-     * @param {TS} defi, Debugnition - The schema definition.
-     * @returns {Schema<TS>} The created `Schema` instance.
-     */
-    static create<TS extends SchemaType>(definition: TS): Schema<TS>;
-
-    /**
-     * The version of the schema.
-     */
-    readonly version: number;
-
-    /**
-     * The primary key of the schema.
-     */
-    readonly primaryKey: string;
-
-    /**
-     * The type of the schema.
-     */
-    readonly type: SchemaFieldType;
-
-    /**
-     * An optional array of indexes.
-     */
-    /**
-     * An optional array of indexes.
-     */
-    readonly indexes?: (Extract<keyof T, string>)[];
-
+type Operation<T extends SchemaType = SchemaType> = {
     /**
-     * An optional array of encrypted fields.
+     * The name of the collection on which the operation will be performed.
      */
-    readonly encrypted?: (Extract<keyof T, string>)[];
+    collection: string,
 
     /**
-     * The properties defined in the schema.
-     */
-    readonly properties: {
-        [K in keyof T['properties'] as T['properties'][K]['required'] extends false | (T['properties'][K]['default'] extends undefined ? true: false)  ? K : never]?: T['properties'][K];
-    } & {
-        [K in keyof T['properties'] as T['properties'][K]['required'] extends false ? never : K]: T['properties'][K];
-    };
-    /**
-     * Converts the schema to a JSON representation.
-     *
-     * @returns {SchemaType} The JSON representation of the schema.
-     */
-    toJSON(): SchemaType;
-
-    validate(document: Doc<Schema<T>>): boolean;
-}
-
-
-
-type EnumerateUpTo<
-    N extends number,
-    Acc extends number[] = []
-> = Acc['length'] extends N ?
-    Acc[number]:
-    EnumerateUpTo<N, [...Acc, Acc['length']]> ;
-
-type EnumerateFrom1To<
-    N extends number
-> = Exclude<EnumerateUpTo<N>,0> | (N extends 0 ? never : N);
-
-type IsVersionGreaterThan0<
-    V extends number
-> = V extends 0 ? false : true;
-
-type AnyVersionGreaterThan1<
-    T extends Record<string, SchemaType>
-> = true extends {
-    [K in keyof T]: IsVersionGreaterThan0<T[K]['version']>;
-} [keyof T] ? true : false;
-
-type MigrationFunction<T extends SchemaType> = (doc: Doc <T> ) => Doc <T>
-
-type MigrationPathsForSchema<
-    T extends SchemaType
-> = T['version'] extends 0 ? {}: // No migrations needed for version 1
-    {
-        [K in EnumerateFrom1To < T['version'] > ]: MigrationFunction<T> ;
-    };
-
-type MigrationPathsForSchemas<
-    T extends SchemaTypeRecord
-> = {
-    [K in keyof T]: MigrationPathsForSchema<T[K]>;
-};
-
-type MigrationsParameter<
-    T extends SchemaTypeRecord
-> = AnyVersionGreaterThan1<T> extends true ?
-    {
-        migrations: MigrationPathsForSchemas<T>
-    }:
-    {
-        migrations?: never
-    };
+     * The type of operation to be performed (e.g., CREATE, UPDATE, DELETE).
+     */
+    opType: OpType,
 
+    /**
+     * The data involved in the operation, conforming to the schema type.
+     */
+    data: Doc<T>,
 
+    primaryKeyField?: string,
+    primaryKey?: string
+}
 
-type Hook = (
-    schema: Schema<SchemaType>,
-    migration: MigrationPathsForSchema<SchemaType>,
-    doc: Doc<SchemaType>
-) => Doc<SchemaType>
 
-type BasePluginOptions = {
-    docCreateHook?: Hook,
-    docRecoverHook?: Hook
-}
 
-declare class BasePlugin implements BasePluginOptions {
-     docCreateHook?:Hook;
-     docRecoverHook?:Hook;
-}
+/**
+ * Represents a database containing collections of documents.
+ * RIDB extends from this class and is used to expose collections.
+ * 
+ * So if you specify:
+ * ```typescript
+ * const db = new RIDB(
+ *     {
+ *         schemas: {
+ *             demo: {
+ *                 version: 0,
+ *                 primaryKey: 'id',
+ *                 type: SchemaFieldType.object,
+ *                 properties: {
+ *                     id: {
+ *                         type: SchemaFieldType.string,
+ *                         maxLength: 60
+ *                     }
+ *                 }
+ *             }
+ *         } as const
+ *     }
+ * )
+ * ```
+ * 
+ * The collection will be available as `db.collections.demo` and all the methods for the collection (find, count, findById, update, create, delete) will be available.
+ *
+ * @template T - A record of schema types.
+ */
+declare class Database<T extends SchemaTypeRecord> {
+
+    /**
+     * Creates a new `Database` instance with the provided schemas and storage module.
+     *
+     * @template TS - A record of schema types.
+     * @param {TS} schemas - The schemas to use for the collections.
+     * @param migrations
+     * @param plugins
+     * @param options
+     * @param password
+     * @returns {Promise<Database<TS>>} A promise that resolves to the created `Database` instance.
+     */
+    static create<TS extends SchemaTypeRecord>(
+        db_name: string,
+        schemas: TS,
+        migrations: MigrationPathsForSchemas<TS> | MigrationPathsForSchema<TS[string]>,
+        plugins:Array<typeof BasePlugin>,
+        options: RIDBModule,
+        password?:string,
+        storage?: BaseStorage<TS>
+    ): Promise<Database<TS>>;
 
+    authenticate(password: string): Promise<boolean>;
 
+    /**
+     * The collections in the database.
+     *
+     * This is a read-only property where the key is the name of the collection and the value is a `Collection` instance.
+     */
+    readonly collections: {
+        [name in keyof T]: Collection<Schema<T[name]>>
+    }
 
-declare const SchemaFieldType = {
-  /**
-   * String type for text data
-   */
-  string: 'string' as const,
-  
-  /**
-   * Number type for numeric data (integers and floats)
-   */
-  number: 'number' as const,
-  
-  /**
-   * Boolean type for true/false values
-   */
-  boolean: 'boolean' as const,
-  
-  /**
-   * Array type for ordered collections of items
-   */
-  array: 'array' as const,
-  
-  /**
-   * Object type for nested document structures
-   */
-  object: 'object' as const,
-};
+    readonly started: boolean;
 
+    /**
+     * Starts the database.
+     *
+     * @returns {Promise<void>} A promise that resolves when the database is started.
+     */
+    start(): Promise<void>;
 
+    /**
+     * Closes the database.
+     *
+     * @returns {Promise<void>} A promise that resolves when the database is closed.
+     */
+    close(): Promise<void>;
+}
 
 /**
- * Represents an in-memory storage system extending the base storage functionality.
+ * Represents a function type for creating storage with the provided schema type records.
  *
- * @template T - The schema type.
+ * @template T - The schema type record.
+ * @param {T} records - The schema type records.
+ * @returns {Promise<InternalsRecord>} A promise that resolves to the created internals record.
  */
-declare class InMemory<T extends SchemaTypeRecord> extends BaseStorage<T> {
+type CreateStorage = <T extends SchemaTypeRecord>(
+    records: T
+) => Promise<BaseStorage<T>>;
+
+/**
+ * Represents a storage module with a method for creating storage.
+ */
+type RIDBModule = {
+
     /**
-     * Frees the resources used by the in-memory storage.
+     * Plugin constructors array
      */
-    free(): void;
-
-    static create<SchemasCreate extends SchemaTypeRecord>(
-        dbName: string,
-        schemas: SchemasCreate,
-    ): Promise<
-        InMemory<
-            SchemasCreate
-        >
-    >;
-}
+    apply: (plugins:Array<typeof BasePlugin>) => Array<BasePlugin>;
+};
 
 
 
@@ -670,92 +564,198 @@ declare abstract class StorageInternal<Schemas extends SchemaTypeRecord> {
 }
 
 
-/**
- * Represents an IndexDB storage system extending the base storage functionality.
- *
- * @template T - The schema type.
- */
-declare class IndexDB<T extends SchemaTypeRecord> extends BaseStorage<T> {
-    /**
-     * Frees the resources used by the in-memory storage.
-     */
-    free(): void;
+type BaseStorageOptions =  {
+    [name:string]:string | boolean | number
+}
 
+declare class BaseStorage<Schemas extends SchemaTypeRecord> extends StorageInternal<Schemas> {
     static create<SchemasCreate extends SchemaTypeRecord>(
         dbName: string,
         schemas: SchemasCreate,
+        options?: BaseStorageOptions
     ): Promise<
-        IndexDB<
+        BaseStorage<
             SchemasCreate
         >
     >;
+    constructor(
+        dbName: string, 
+        schemas: Schemas, 
+        options?: BaseStorageOptions
+    );
+    readonly dbName: string;
+    readonly schemas: Record<keyof Schemas, Schema<Schemas[keyof Schemas]>>;
+    readonly options: BaseStorageOptions;
+    readonly core: CoreStorage;
+    start(): Promise<void>;
+    close(): Promise<void>;
+    count(colectionName: keyof Schemas, query: QueryType<Schemas[keyof Schemas]>, options?: QueryOptions): Promise<number>;
+    findDocumentById(collectionName: keyof Schemas, id: string): Promise<Doc<Schemas[keyof Schemas]> | null>;
+    find(collectionName: keyof Schemas, query: QueryType<Schemas[keyof Schemas]>, options?: QueryOptions): Promise<Doc<Schemas[keyof Schemas]>[]>;
+    write(op: Operation<Schemas[keyof Schemas]>): Promise<Doc<Schemas[keyof Schemas]>>;
+    getOption(name: string): string | boolean | number | undefined;
+    getSchema(name: string): Schema<any>;
+    //Call addIndexSchemas if you need extra indexing schemas for your database
+    addIndexSchemas(): null
 }
 
 
 
 /**
- * Represents a property within a schema, including various constraints and nested properties.
+ * Represents the type definition for a schema.
  */
-declare class Property {
+type SchemaType = {
     /**
-     * The type of the property.
+     * The version of the schema.
      */
-    readonly type: SchemaFieldType;
+     version: number;
 
     /**
-     * The version of the property, if applicable.
+     * The primary key of the schema.
      */
-    readonly version?: number;
+     primaryKey: string;
 
     /**
-     * The primary key of the property, if applicable.
+     * The type of the schema.
      */
-    readonly primaryKey?: string;
+     type: SchemaFieldType;
+     indexes?:  string[];
+     encrypted?:  string[];
+    /**
+     * The properties defined in the schema.
+     */
+     properties: {
+        [name: string]: Property;
+    };
+};
+
+
+/**
+ * Represents a schema, including its definition and related methods.
+ * You may be trying to build a storage, in any other can u won't need access tho this class.
+ * Check this example 
+ * 
+ * ```typescript
+ * class MyStorage extends <T extends SchemaTypeRecord> extends BaseStorage<T> {
+ *  example() {
+ *    const schema: Schema<any> = this.getSchema("mySchema")
+ *  }
+ * }
+ * ```
+ * You alwayswill have access to getSchema through the Storage class.
+ * 
+ * @template T - The schema type.
+ */
+declare class Schema<T extends SchemaType> {
+    /**
+     * The schema definition.
+     */
+    schema: Schema<T>;
 
     /**
-     * An optional array of nested properties for array-type properties.
+     * Creates a new `Schema` instance from the provided definition.
+     *
+     * @template TS - The schema type.
+     * @param {TS} defi, Debugnition - The schema definition.
+     * @returns {Schema<TS>} The created `Schema` instance.
      */
-    readonly items?: Property;
+    static create<TS extends SchemaType>(definition: TS): Schema<TS>;
 
     /**
-     * The maximum number of items for array-type properties, if applicable.
+     * The version of the schema.
      */
-    readonly maxItems?: number;
+    readonly version: number;
 
     /**
-     * The minimum number of items for array-type properties, if applicable.
+     * The primary key of the schema.
      */
-    readonly minItems?: number;
+    readonly primaryKey: string;
 
     /**
-     * The maximum length for string-type properties, if applicable.
+     * The type of the schema.
      */
-    readonly maxLength?: number;
+    readonly type: SchemaFieldType;
 
     /**
-     * The minimum length for string-type properties, if applicable.
+     * An optional array of indexes.
      */
-    readonly minLength?: number;
-
     /**
-     * An optional array of required fields for object-type properties.
+     * An optional array of indexes.
      */
-    readonly required?: boolean;
+    readonly indexes?: (Extract<keyof T, string>)[];
 
     /**
-     * An optional default value for the property.
+     * An optional array of encrypted fields.
      */
-    readonly default?: any;
+    readonly encrypted?: (Extract<keyof T, string>)[];
 
     /**
-     * An optional map of nested properties for object-type properties.
+     * The properties defined in the schema.
      */
-    readonly properties?: {
-        [name: string]: Property;
+    readonly properties: {
+        [K in keyof T['properties'] as T['properties'][K]['required'] extends false | (T['properties'][K]['default'] extends undefined ? true: false)  ? K : never]?: T['properties'][K];
+    } & {
+        [K in keyof T['properties'] as T['properties'][K]['required'] extends false ? never : K]: T['properties'][K];
     };
+    /**
+     * Converts the schema to a JSON representation.
+     *
+     * @returns {SchemaType} The JSON representation of the schema.
+     */
+    toJSON(): SchemaType;
+
+    validate(document: Doc<Schema<T>>): boolean;
 }
 
 
+
+type EnumerateUpTo<
+    N extends number,
+    Acc extends number[] = []
+> = Acc['length'] extends N ?
+    Acc[number]:
+    EnumerateUpTo<N, [...Acc, Acc['length']]> ;
+
+type EnumerateFrom1To<
+    N extends number
+> = Exclude<EnumerateUpTo<N>,0> | (N extends 0 ? never : N);
+
+type IsVersionGreaterThan0<
+    V extends number
+> = V extends 0 ? false : true;
+
+type AnyVersionGreaterThan1<
+    T extends Record<string, SchemaType>
+> = true extends {
+    [K in keyof T]: IsVersionGreaterThan0<T[K]['version']>;
+} [keyof T] ? true : false;
+
+type MigrationFunction<T extends SchemaType> = (doc: Doc <T> ) => Doc <T>
+
+type MigrationPathsForSchema<
+    T extends SchemaType
+> = T['version'] extends 0 ? {}: // No migrations needed for version 1
+    {
+        [K in EnumerateFrom1To < T['version'] > ]: MigrationFunction<T> ;
+    };
+
+type MigrationPathsForSchemas<
+    T extends SchemaTypeRecord
+> = {
+    [K in keyof T]: MigrationPathsForSchema<T[K]>;
+};
+
+type MigrationsParameter<
+    T extends SchemaTypeRecord
+> = AnyVersionGreaterThan1<T> extends true ?
+    {
+        migrations: MigrationPathsForSchemas<T>
+    }:
+    {
+        migrations?: never
+    };
+
+
 /**
 */
 declare class RIDBError {
@@ -867,43 +867,55 @@ type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Modul
 
 interface InitOutput {
   readonly memory: WebAssembly.Memory;
-  readonly corestorage_new: () => number;
-  readonly corestorage_getPrimaryKeyTyped: (a: number, b: number, c: number) => void;
-  readonly corestorage_getIndexes: (a: number, b: number, c: number, d: number) => void;
-  readonly corestorage_matchesQuery: (a: number, b: number, c: number, d: number) => void;
-  readonly __wbg_database_free: (a: number) => void;
-  readonly database_start: (a: number) => number;
-  readonly database_close: (a: number) => number;
-  readonly database_started: (a: number) => number;
-  readonly database_authenticate: (a: number, b: number, c: number) => number;
-  readonly database_collections: (a: number, b: number) => void;
-  readonly database_create: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => number;
-  readonly __wbg_operation_free: (a: number) => void;
-  readonly operation_collection: (a: number, b: number) => void;
-  readonly operation_opType: (a: number) => number;
-  readonly operation_data: (a: number) => number;
-  readonly operation_primaryKeyField: (a: number) => number;
-  readonly operation_primaryKey: (a: number) => number;
-  readonly operation_primaryKeyIndex: (a: number, b: number) => void;
-  readonly __wbg_corestorage_free: (a: number) => void;
-  readonly __wbg_collection_free: (a: number) => void;
-  readonly collection_name: (a: number, b: number) => void;
-  readonly collection_schema: (a: number, b: number) => void;
-  readonly collection_find: (a: number, b: number, c: number) => number;
-  readonly collection_parse_query_options: (a: number, b: number, c: number) => void;
-  readonly collection_count: (a: number, b: number, c: number) => number;
-  readonly collection_findById: (a: number, b: number) => number;
-  readonly collection_update: (a: number, b: number) => number;
-  readonly collection_create: (a: number, b: number) => number;
-  readonly collection_delete: (a: number, b: number) => number;
-  readonly __wbg_basestorage_free: (a: number) => void;
-  readonly basestorage_new: (a: number, b: number, c: number, d: number, e: number) => void;
-  readonly basestorage_addIndexSchemas: (a: number, b: number) => void;
-  readonly basestorage_getOption: (a: number, b: number, c: number, d: number) => void;
-  readonly basestorage_getSchema: (a: number, b: number, c: number, d: number) => void;
-  readonly basestorage_core: (a: number, b: number) => void;
-  readonly main_js: () => void;
-  readonly is_debug_mode: () => number;
+  readonly __wbg_property_free: (a: number) => void;
+  readonly property_is_valid: (a: number, b: number) => void;
+  readonly property_type: (a: number) => number;
+  readonly property_items: (a: number, b: number) => void;
+  readonly property_maxItems: (a: number, b: number) => void;
+  readonly property_minItems: (a: number, b: number) => void;
+  readonly property_maxLength: (a: number, b: number) => void;
+  readonly property_minLength: (a: number, b: number) => void;
+  readonly property_properties: (a: number, b: number) => void;
+  readonly __wbgt_test_property_creation_0: (a: number) => void;
+  readonly __wbgt_test_property_validation_1: (a: number) => void;
+  readonly __wbgt_test_invalid_property_2: (a: number) => void;
+  readonly __wbg_ridberror_free: (a: number) => void;
+  readonly ridberror_new: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly ridberror_type: (a: number, b: number) => void;
+  readonly ridberror_code: (a: number) => number;
+  readonly ridberror_message: (a: number, b: number) => void;
+  readonly ridberror_from: (a: number) => number;
+  readonly ridberror_error: (a: number, b: number, c: number) => number;
+  readonly ridberror_query: (a: number, b: number, c: number) => number;
+  readonly ridberror_authentication: (a: number, b: number, c: number) => number;
+  readonly ridberror_serialisation: (a: number, b: number, c: number) => number;
+  readonly ridberror_validation: (a: number, b: number, c: number) => number;
+  readonly ridberror_hook: (a: number, b: number, c: number) => number;
+  readonly __wbg_indexdb_free: (a: number) => void;
+  readonly indexdb_get_stores: (a: number, b: number) => void;
+  readonly indexdb_get_store: (a: number, b: number, c: number, d: number) => void;
+  readonly indexdb_create: (a: number, b: number, c: number) => number;
+  readonly indexdb_write: (a: number, b: number) => number;
+  readonly indexdb_find: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly indexdb_findDocumentById: (a: number, b: number, c: number, d: number) => number;
+  readonly indexdb_count: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly indexdb_close: (a: number) => number;
+  readonly indexdb_start: (a: number) => number;
+  readonly __wbg_inmemory_free: (a: number) => void;
+  readonly inmemory_create: (a: number, b: number, c: number) => number;
+  readonly inmemory_write: (a: number, b: number) => number;
+  readonly inmemory_find: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly inmemory_findDocumentById: (a: number, b: number, c: number, d: number) => number;
+  readonly inmemory_count: (a: number, b: number, c: number, d: number, e: number) => number;
+  readonly inmemory_close: (a: number) => number;
+  readonly inmemory_start: (a: number) => number;
+  readonly __wbg_baseplugin_free: (a: number) => void;
+  readonly baseplugin_new: (a: number, b: number, c: number) => void;
+  readonly baseplugin_name: (a: number) => number;
+  readonly baseplugin_get_doc_create_hook: (a: number) => number;
+  readonly baseplugin_get_doc_recover_hook: (a: number) => number;
+  readonly baseplugin_set_doc_create_hook: (a: number, b: number) => void;
+  readonly baseplugin_set_doc_recover_hook: (a: number, b: number) => void;
   readonly __wbg_query_free: (a: number) => void;
   readonly query_new: (a: number, b: number, c: number) => void;
   readonly query_query: (a: number, b: number) => void;
@@ -940,6 +952,46 @@ interface InitOutput {
   readonly __wbgt_test_query_parse_eq_operator_wrong_type_32: (a: number) => void;
   readonly __wbgt_test_query_parse_ne_operator_33: (a: number) => void;
   readonly __wbgt_test_query_parse_ne_operator_wrong_type_34: (a: number) => void;
+  readonly main_js: () => void;
+  readonly is_debug_mode: () => number;
+  readonly __wbg_collection_free: (a: number) => void;
+  readonly collection_name: (a: number, b: number) => void;
+  readonly collection_schema: (a: number, b: number) => void;
+  readonly collection_find: (a: number, b: number, c: number) => number;
+  readonly collection_parse_query_options: (a: number, b: number, c: number) => void;
+  readonly collection_count: (a: number, b: number, c: number) => number;
+  readonly collection_findById: (a: number, b: number) => number;
+  readonly collection_update: (a: number, b: number) => number;
+  readonly collection_create: (a: number, b: number) => number;
+  readonly collection_delete: (a: number, b: number) => number;
+  readonly corestorage_new: () => number;
+  readonly corestorage_getPrimaryKeyTyped: (a: number, b: number, c: number) => void;
+  readonly corestorage_getIndexes: (a: number, b: number, c: number, d: number) => void;
+  readonly corestorage_matchesQuery: (a: number, b: number, c: number, d: number) => void;
+  readonly __wbg_queryoptions_free: (a: number) => void;
+  readonly queryoptions_limit: (a: number, b: number) => void;
+  readonly queryoptions_offset: (a: number, b: number) => void;
+  readonly __wbg_operation_free: (a: number) => void;
+  readonly operation_collection: (a: number, b: number) => void;
+  readonly operation_opType: (a: number) => number;
+  readonly operation_data: (a: number) => number;
+  readonly operation_primaryKeyField: (a: number) => number;
+  readonly operation_primaryKey: (a: number) => number;
+  readonly operation_primaryKeyIndex: (a: number, b: number) => void;
+  readonly __wbg_corestorage_free: (a: number) => void;
+  readonly __wbg_database_free: (a: number) => void;
+  readonly database_start: (a: number) => number;
+  readonly database_close: (a: number) => number;
+  readonly database_started: (a: number) => number;
+  readonly database_authenticate: (a: number, b: number, c: number) => number;
+  readonly database_collections: (a: number, b: number) => void;
+  readonly database_create: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number) => number;
+  readonly __wbg_basestorage_free: (a: number) => void;
+  readonly basestorage_new: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly basestorage_addIndexSchemas: (a: number, b: number) => void;
+  readonly basestorage_getOption: (a: number, b: number, c: number, d: number) => void;
+  readonly basestorage_getSchema: (a: number, b: number, c: number, d: number) => void;
+  readonly basestorage_core: (a: number, b: number) => void;
   readonly __wbg_schema_free: (a: number) => void;
   readonly schema_validate: (a: number, b: number, c: number) => void;
   readonly schema_is_valid: (a: number, b: number) => void;
@@ -953,58 +1005,6 @@ interface InitOutput {
   readonly __wbgt_test_schema_creation_3: (a: number) => void;
   readonly __wbgt_test_schema_validation_4: (a: number) => void;
   readonly __wbgt_test_invalid_schema_5: (a: number) => void;
-  readonly __wbg_baseplugin_free: (a: number) => void;
-  readonly baseplugin_new: (a: number, b: number, c: number) => void;
-  readonly baseplugin_name: (a: number) => number;
-  readonly baseplugin_get_doc_create_hook: (a: number) => number;
-  readonly baseplugin_get_doc_recover_hook: (a: number) => number;
-  readonly baseplugin_set_doc_create_hook: (a: number, b: number) => void;
-  readonly baseplugin_set_doc_recover_hook: (a: number, b: number) => void;
-  readonly __wbg_inmemory_free: (a: number) => void;
-  readonly inmemory_create: (a: number, b: number, c: number) => number;
-  readonly inmemory_write: (a: number, b: number) => number;
-  readonly inmemory_find: (a: number, b: number, c: number, d: number, e: number) => number;
-  readonly inmemory_findDocumentById: (a: number, b: number, c: number, d: number) => number;
-  readonly inmemory_count: (a: number, b: number, c: number, d: number, e: number) => number;
-  readonly inmemory_close: (a: number) => number;
-  readonly inmemory_start: (a: number) => number;
-  readonly __wbg_ridberror_free: (a: number) => void;
-  readonly ridberror_new: (a: number, b: number, c: number, d: number, e: number) => number;
-  readonly ridberror_type: (a: number, b: number) => void;
-  readonly ridberror_code: (a: number) => number;
-  readonly ridberror_message: (a: number, b: number) => void;
-  readonly ridberror_from: (a: number) => number;
-  readonly ridberror_error: (a: number, b: number, c: number) => number;
-  readonly ridberror_query: (a: number, b: number, c: number) => number;
-  readonly ridberror_authentication: (a: number, b: number, c: number) => number;
-  readonly ridberror_serialisation: (a: number, b: number, c: number) => number;
-  readonly ridberror_validation: (a: number, b: number, c: number) => number;
-  readonly ridberror_hook: (a: number, b: number, c: number) => number;
-  readonly __wbg_indexdb_free: (a: number) => void;
-  readonly indexdb_get_stores: (a: number, b: number) => void;
-  readonly indexdb_get_store: (a: number, b: number, c: number, d: number) => void;
-  readonly indexdb_create: (a: number, b: number, c: number) => number;
-  readonly indexdb_write: (a: number, b: number) => number;
-  readonly indexdb_find: (a: number, b: number, c: number, d: number, e: number) => number;
-  readonly indexdb_findDocumentById: (a: number, b: number, c: number, d: number) => number;
-  readonly indexdb_count: (a: number, b: number, c: number, d: number, e: number) => number;
-  readonly indexdb_close: (a: number) => number;
-  readonly indexdb_start: (a: number) => number;
-  readonly __wbg_queryoptions_free: (a: number) => void;
-  readonly queryoptions_limit: (a: number, b: number) => void;
-  readonly queryoptions_offset: (a: number, b: number) => void;
-  readonly __wbg_property_free: (a: number) => void;
-  readonly property_is_valid: (a: number, b: number) => void;
-  readonly property_type: (a: number) => number;
-  readonly property_items: (a: number, b: number) => void;
-  readonly property_maxItems: (a: number, b: number) => void;
-  readonly property_minItems: (a: number, b: number) => void;
-  readonly property_maxLength: (a: number, b: number) => void;
-  readonly property_minLength: (a: number, b: number) => void;
-  readonly property_properties: (a: number, b: number) => void;
-  readonly __wbgt_test_property_creation_0: (a: number) => void;
-  readonly __wbgt_test_property_validation_1: (a: number) => void;
-  readonly __wbgt_test_invalid_property_2: (a: number) => void;
   readonly __wbg_wasmbindgentestcontext_free: (a: number) => void;
   readonly wasmbindgentestcontext_new: () => number;
   readonly wasmbindgentestcontext_args: (a: number, b: number, c: number) => void;
@@ -1020,7 +1020,7 @@ interface InitOutput {
   readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
   readonly _dyn_core__ops__function__Fn__A_B_C___Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h1d7727fe9471ac49: (a: number, b: number, c: number, d: number, e: number, f: number) => void;
   readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h4e550b82c2b30c7a: (a: number, b: number, c: number) => void;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hef4d0d64e714d731: (a: number, b: number, c: number) => number;
+  readonly _dyn_core__ops__function__FnMut_____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hec0cc069f718ed78: (a: number, b: number) => void;
   readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf401bdfdf8c9bdd9: (a: number, b: number, c: number) => void;
   readonly __wbindgen_free: (a: number, b: number, c: number) => void;
   readonly __wbindgen_exn_store: (a: number) => void;