@trust0/ridb-core 1.5.1-rc.2 → 1.5.2

package/package.json

@@ -5,12 +5,18 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.5.1-rc.2",
+  "version": "1.5.2",
   "main": "./pkg/ridb_core.js",
   "types": "./pkg/ridb_core.d.ts",
   "sideEffects": [
     "./pkg/snippets/*"
   ],
+  "scripts": {
+    "clean": "rm -rf build node_modules",
+    "test": "sh test.sh",
+    "build": "sh build.sh",
+    "docs": "echo 'No docs for this package'"
+  },
   "files": [
     "./pkg/ridb_core_bg.wasm",
     "./pkg/ridb_core.js",

package/pkg/ridb_core.d.ts

@@ -187,7 +187,7 @@ export class BaseStorage<Schemas extends SchemaTypeRecord> extends StorageIntern
 
 
 /**
- * Represents a database containing collections.
+ * Represents a database containing collections of documents.
  * RIDB extends from this class and is used to expose collections.
  * 
  * So if you specify:
@@ -238,6 +238,8 @@ export class Database<T extends SchemaTypeRecord> {
         storage?: BaseStorage<TS>
     ): Promise<Database<TS>>;
 
+    authenticate(password: string): Promise<boolean>;
+
     /**
      * The collections in the database.
      *
@@ -265,7 +267,7 @@ export class Database<T extends SchemaTypeRecord> {
 }
 
 /**
- * Represents a function for creating storage with the provided schema type records.
+ * 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.
@@ -352,70 +354,6 @@ export class BasePlugin implements BasePluginOptions {
 
 
 
-/**
- * Represents a property within a schema, including various constraints and nested properties.
- */
-export class Property {
-    /**
-     * The type of the property.
-     */
-    readonly type: string;
-
-    /**
-     * 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 the type definition for a schema.
  */
@@ -623,40 +561,6 @@ export class Collection<T extends SchemaType> {
 
 
 
-/**
- * Represents a record of schema types, where each key is a string and the value is a `SchemaType`.
- */
-export type SchemaTypeRecord = {
-    [name: string]: SchemaType
-};
-
-export 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]>>;
-}
-
-
 export type EnumerateUpTo<
     N extends number,
     Acc extends number[] = []
@@ -704,6 +608,104 @@ export type MigrationsParameter<
     };
 
 
+
+/**
+ * Represents a property within a schema, including various constraints and nested properties.
+ */
+export class Property {
+    /**
+     * The type of the property.
+     */
+    readonly type: string;
+
+    /**
+     * 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`.
+ */
+export type SchemaTypeRecord = {
+    [name: string]: SchemaType
+};
+
+export 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]>>;
+}
+
 /**
 */
 export class RIDBError {
@@ -887,6 +889,7 @@ export interface InitOutput {
   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;
@@ -917,18 +920,6 @@ export 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_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_schema_free: (a: number) => void;
   readonly schema_validate: (a: number, b: number, c: number) => void;
   readonly schema_is_valid: (a: number, b: number) => void;
@@ -952,6 +943,18 @@ export interface InitOutput {
   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_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;

package/pkg/ridb_core.js

@@ -409,15 +409,15 @@ export function __wbgtest_console_error(args) {
     }
 }
 
-function __wbg_adapter_295(arg0, arg1) {
+function __wbg_adapter_296(arg0, arg1) {
     wasm.wasm_bindgen__convert__closures__invoke0_mut__hf4bced6426ca6f31(arg0, arg1);
 }
 
-function __wbg_adapter_338(arg0, arg1, arg2, arg3, arg4) {
+function __wbg_adapter_339(arg0, arg1, arg2, arg3, arg4) {
     wasm.wasm_bindgen__convert__closures__invoke3_mut__h425269a7185d1f5b(arg0, arg1, addHeapObject(arg2), arg3, addHeapObject(arg4));
 }
 
-function __wbg_adapter_389(arg0, arg1, arg2, arg3) {
+function __wbg_adapter_390(arg0, arg1, arg2, arg3) {
     wasm.wasm_bindgen__convert__closures__invoke2_mut__h1b9fff078715ef14(arg0, arg1, addHeapObject(arg2), addHeapObject(arg3));
 }
 
@@ -977,6 +977,16 @@ export class Database {
         return ret !== 0;
     }
     /**
+    * @param {string} password
+    * @returns {Promise<boolean>}
+    */
+    authenticate(password) {
+        const ptr0 = passStringToWasm0(password, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.database_authenticate(this.__wbg_ptr, ptr0, len0);
+        return takeObject(ret);
+    }
+    /**
     * Retrieves the collections in the database.
     *
     * This function returns an `Object` containing the collections.
@@ -2703,7 +2713,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_295(a, state0.b, );
+                    return __wbg_adapter_296(a, state0.b, );
                 } finally {
                     state0.a = a;
                 }
@@ -2868,7 +2878,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_338(a, state0.b, arg0, arg1, arg2);
+                    return __wbg_adapter_339(a, state0.b, arg0, arg1, arg2);
                 } finally {
                     state0.a = a;
                 }
@@ -2947,7 +2957,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_389(a, state0.b, arg0, arg1);
+                    return __wbg_adapter_390(a, state0.b, arg0, arg1);
                 } finally {
                     state0.a = a;
                 }
@@ -3047,20 +3057,20 @@ function __wbg_get_imports() {
         const ret = wasm.memory;
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper495 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 177, __wbg_adapter_56);
+    imports.wbg.__wbindgen_closure_wrapper499 = function(arg0, arg1, arg2) {
+        const ret = makeMutClosure(arg0, arg1, 181, __wbg_adapter_56);
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper497 = function(arg0, arg1, arg2) {
-        const ret = makeClosure(arg0, arg1, 177, __wbg_adapter_59);
+    imports.wbg.__wbindgen_closure_wrapper501 = function(arg0, arg1, arg2) {
+        const ret = makeClosure(arg0, arg1, 181, __wbg_adapter_59);
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper499 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 177, __wbg_adapter_62);
+    imports.wbg.__wbindgen_closure_wrapper503 = function(arg0, arg1, arg2) {
+        const ret = makeMutClosure(arg0, arg1, 181, __wbg_adapter_62);
         return addHeapObject(ret);
     };
-    imports.wbg.__wbindgen_closure_wrapper1619 = function(arg0, arg1, arg2) {
-        const ret = makeMutClosure(arg0, arg1, 449, __wbg_adapter_65);
+    imports.wbg.__wbindgen_closure_wrapper1625 = function(arg0, arg1, arg2) {
+        const ret = makeMutClosure(arg0, arg1, 453, __wbg_adapter_65);
         return addHeapObject(ret);
     };