@trust0/ridb-core 1.7.28 → 1.7.30

package/build/ridb_core.d.ts

@@ -73,70 +73,6 @@ declare enum Errors {
   AuthenticationError = 5,
 }
 
-/**
- * Represents a property within a schema, including various constraints and nested properties.
- */
-declare class Property {
-    /**
-     * 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;
-
-    /**
-     * An optional array of nested properties for array-type properties.
-     */
-    readonly items?: Property;
-
-    /**
-     * The maximum number of items for array-type properties, if applicable.
-     */
-    readonly maxItems?: number;
-
-    /**
-     * The minimum number of items for array-type properties, if applicable.
-     */
-    readonly minItems?: number;
-
-    /**
-     * The maximum length for string-type properties, if applicable.
-     */
-    readonly maxLength?: number;
-
-    /**
-     * The minimum length for string-type properties, if applicable.
-     */
-    readonly minLength?: number;
-
-    /**
-     * An optional array of required fields for object-type properties.
-     */
-    readonly required?: boolean;
-
-    /**
-     * An optional default value for the property.
-     */
-    readonly default?: any;
-
-    /**
-     * An optional map of nested properties for object-type properties.
-     */
-    readonly properties?: {
-        [name: string]: Property;
-    };
-}
-
-
-
 /**
  * Represents an IndexDB storage system extending the base storage functionality.
  *
@@ -201,6 +137,162 @@ declare class BasePlugin implements BasePluginOptions {
 
 
 
+/**
+ * Represents the type definition for a schema.
+ */
+type SchemaType = {
+    /**
+     * The version of the schema.
+     */
+     version: number;
+
+    /**
+     * The primary key of the schema.
+     */
+     primaryKey: 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.
+ */
+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>)[];
+
+    /**
+     * An optional array of encrypted fields.
+     */
+    readonly encrypted?: (Extract<keyof T, 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
+    };
+
+
+
 type Operators<T> = {
     $gte?: number,
     $gt?: number
@@ -237,32 +329,67 @@ declare class Query<T extends SchemaType> {
 
 
 
-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,
-};
+/**
+ * Represents a property within a schema, including various constraints and nested properties.
+ */
+declare class Property {
+    /**
+     * 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;
+
+    /**
+     * An optional array of nested properties for array-type properties.
+     */
+    readonly items?: Property;
+
+    /**
+     * The maximum number of items for array-type properties, if applicable.
+     */
+    readonly maxItems?: number;
+
+    /**
+     * The minimum number of items for array-type properties, if applicable.
+     */
+    readonly minItems?: number;
+
+    /**
+     * The maximum length for string-type properties, if applicable.
+     */
+    readonly maxLength?: number;
+
+    /**
+     * The minimum length for string-type properties, if applicable.
+     */
+    readonly minLength?: number;
+
+    /**
+     * An optional array of required fields for object-type properties.
+     */
+    readonly required?: boolean;
+
+    /**
+     * An optional default value for the property.
+     */
+    readonly default?: any;
+
+    /**
+     * An optional map of nested properties for object-type properties.
+     */
+    readonly properties?: {
+        [name: string]: Property;
+    };
+}
 
 
 
@@ -529,6 +656,35 @@ type RIDBModule = {
 
 
 
+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,
+};
+
+
+
 /**
  * Represents a record of schema types, where each key is a string and the value is a `SchemaType`.
  * @internal
@@ -600,162 +756,6 @@ declare class BaseStorage<Schemas extends SchemaTypeRecord> extends StorageInter
 }
 
 
-
-/**
- * Represents the type definition for a schema.
- */
-type SchemaType = {
-    /**
-     * The version of the schema.
-     */
-     version: number;
-
-    /**
-     * The primary key of the schema.
-     */
-     primaryKey: 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.
- */
-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>)[];
-
-    /**
-     * An optional array of encrypted fields.
-     */
-    readonly encrypted?: (Extract<keyof T, 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
-    };
-
-
 /**
 */
 declare class RIDBError {
@@ -867,18 +867,6 @@ type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Modul
 
 interface InitOutput {
   readonly memory: WebAssembly.Memory;
-  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;
@@ -916,6 +904,19 @@ interface InitOutput {
   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_schema_free: (a: number) => void;
+  readonly schema_validate: (a: number, b: number, c: number) => void;
+  readonly schema_is_valid: (a: number, b: number) => void;
+  readonly schema_create: (a: number, b: number) => void;
+  readonly schema_version: (a: number) => number;
+  readonly schema_primaryKey: (a: number, b: number) => void;
+  readonly schema_type: (a: number, b: number) => void;
+  readonly schema_indexes: (a: number, b: number) => void;
+  readonly schema_encrypted: (a: number, b: number) => void;
+  readonly schema_properties: (a: number, b: number) => void;
+  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_query_free: (a: number) => void;
   readonly query_new: (a: number, b: number, c: number) => void;
   readonly query_query: (a: number, b: number) => void;
@@ -952,8 +953,18 @@ 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_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_collection_free: (a: number) => void;
   readonly collection_name: (a: number, b: number) => void;
   readonly collection_schema: (a: number, b: number) => void;
@@ -986,25 +997,14 @@ interface InitOutput {
   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 main_js: () => void;
+  readonly is_debug_mode: () => 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;
-  readonly schema_create: (a: number, b: number) => void;
-  readonly schema_version: (a: number) => number;
-  readonly schema_primaryKey: (a: number, b: number) => void;
-  readonly schema_type: (a: number, b: number) => void;
-  readonly schema_indexes: (a: number, b: number) => void;
-  readonly schema_encrypted: (a: number, b: number) => void;
-  readonly schema_properties: (a: number, b: number) => void;
-  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_wasmbindgentestcontext_free: (a: number) => void;
   readonly wasmbindgentestcontext_new: () => number;
   readonly wasmbindgentestcontext_args: (a: number, b: number, c: number) => void;