@trust0/ridb-core 1.7.34 → 1.7.35

package/build/ridb_core.d.ts

@@ -73,6 +73,122 @@ 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;
+    };
+}
+
+
+
+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 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;
+
+    static create<SchemasCreate extends SchemaTypeRecord>(
+        dbName: string,
+        schemas: SchemasCreate,
+    ): Promise<
+        IndexDB<
+            SchemasCreate
+        >
+    >;
+}
+
+
+
 type InternalsRecord = {
     [name: string]: BaseStorage<SchemaTypeRecord>
 };
@@ -232,6 +348,148 @@ type Operation<T extends SchemaType = SchemaType> = {
 
 
 
+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>;
+}
+
+
+
+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
+    };
+
+
+
+/**
+ * Represents an in-memory storage system extending the base storage functionality.
+ *
+ * @template T - The schema type.
+ */
+declare class InMemory<T extends SchemaTypeRecord> extends BaseStorage<T> {
+    /**
+     * Frees the resources used by the in-memory storage.
+     */
+    free(): void;
+
+    static create<SchemasCreate extends SchemaTypeRecord>(
+        dbName: string,
+        schemas: SchemasCreate,
+    ): Promise<
+        InMemory<
+            SchemasCreate
+        >
+    >;
+}
+
+
+
+/**
+ * Represents a record of schema types, where each key is a string and the value is a `SchemaType`.
+ * @internal
+ */
+type SchemaTypeRecord = {
+    [name: string]: SchemaType
+};
+
+declare abstract class StorageInternal<Schemas extends SchemaTypeRecord> {
+    constructor(
+        name: string, 
+        schemas: Schemas
+    );
+    abstract start(): Promise<void>;
+    abstract close(): Promise<void>;
+    abstract count(
+        colectionName: keyof Schemas, 
+        query: QueryType<Schemas[keyof Schemas]>,
+        options?: QueryOptions
+    ): Promise<number>;
+    abstract findDocumentById(
+        collectionName: keyof Schemas, 
+        id: string
+    ): Promise<Doc<Schemas[keyof Schemas]> | null>;
+    abstract find(
+        collectionName: keyof Schemas, 
+        query: QueryType<Schemas[keyof Schemas]>,
+        options?: QueryOptions
+    ): Promise<Doc<Schemas[keyof Schemas]>[]>;
+    abstract write(
+        op: Operation<Schemas[keyof Schemas]>
+    ): Promise<Doc<Schemas[keyof Schemas]>>;
+}
+
+
 type BaseStorageOptions =  {
     [name:string]:string | boolean | number
 }
@@ -381,120 +639,13 @@ type Hook = (
 
 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>;
-}
-
-
-
-/**
- * Represents an in-memory storage system extending the base storage functionality.
- *
- * @template T - The schema type.
- */
-declare class InMemory<T extends SchemaTypeRecord> extends BaseStorage<T> {
-    /**
-     * Frees the resources used by the in-memory storage.
-     */
-    free(): void;
-
-    static create<SchemasCreate extends SchemaTypeRecord>(
-        dbName: string,
-        schemas: SchemasCreate,
-    ): Promise<
-        InMemory<
-            SchemasCreate
-        >
-    >;
-}
-
-
-
-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]>;
-};
+    docRecoverHook?: Hook
+}
 
-type MigrationsParameter<
-    T extends SchemaTypeRecord
-> = AnyVersionGreaterThan1<T> extends true ?
-    {
-        migrations: MigrationPathsForSchemas<T>
-    }:
-    {
-        migrations?: never
-    };
+declare class BasePlugin implements BasePluginOptions {
+     docCreateHook?:Hook;
+     docRecoverHook?:Hook;
+}
 
 
 
@@ -605,157 +756,6 @@ declare class Schema<T extends SchemaType> {
 }
 
 
-
-/**
- * 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 a record of schema types, where each key is a string and the value is a `SchemaType`.
- * @internal
- */
-type SchemaTypeRecord = {
-    [name: string]: SchemaType
-};
-
-declare abstract class StorageInternal<Schemas extends SchemaTypeRecord> {
-    constructor(
-        name: string, 
-        schemas: Schemas
-    );
-    abstract start(): Promise<void>;
-    abstract close(): Promise<void>;
-    abstract count(
-        colectionName: keyof Schemas, 
-        query: QueryType<Schemas[keyof Schemas]>,
-        options?: QueryOptions
-    ): Promise<number>;
-    abstract findDocumentById(
-        collectionName: keyof Schemas, 
-        id: string
-    ): Promise<Doc<Schemas[keyof Schemas]> | null>;
-    abstract find(
-        collectionName: keyof Schemas, 
-        query: QueryType<Schemas[keyof Schemas]>,
-        options?: QueryOptions
-    ): Promise<Doc<Schemas[keyof Schemas]>[]>;
-    abstract write(
-        op: Operation<Schemas[keyof Schemas]>
-    ): Promise<Doc<Schemas[keyof Schemas]>>;
-}
-
-
-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 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;
-
-    static create<SchemasCreate extends SchemaTypeRecord>(
-        dbName: string,
-        schemas: SchemasCreate,
-    ): Promise<
-        IndexDB<
-            SchemasCreate
-        >
-    >;
-}
-
-
 /**
 */
 declare class RIDBError {
@@ -867,6 +867,28 @@ 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_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_collection_free: (a: number) => void;
   readonly collection_name: (a: number, b: number) => void;
   readonly collection_schema: (a: number, b: number) => void;
@@ -889,29 +911,6 @@ interface InitOutput {
   readonly operation_primaryKeyIndex: (a: number, b: number) => void;
   readonly corestorage_new: () => number;
   readonly __wbg_corestorage_free: (a: number) => void;
-  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_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_queryoptions_free: (a: number) => void;
-  readonly queryoptions_limit: (a: number, b: number) => void;
-  readonly queryoptions_offset: (a: number, b: 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_query_free: (a: number) => void;
   readonly query_new: (a: number, b: number, c: number) => void;
   readonly query_query: (a: number, b: number) => void;
@@ -959,6 +958,29 @@ interface InitOutput {
   readonly inmemory_start: (a: 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_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_queryoptions_free: (a: number) => void;
+  readonly queryoptions_limit: (a: number, b: number) => void;
+  readonly queryoptions_offset: (a: number, b: 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_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;
@@ -984,28 +1006,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_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_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_wasmbindgentestcontext_free: (a: number) => void;
   readonly wasmbindgentestcontext_new: () => number;
   readonly wasmbindgentestcontext_args: (a: number, b: number, c: number) => void;