@trust0/ridb-core 1.4.3 → 1.5.0-rc.1

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.4.3",
+  "version": "1.5.0-rc.1",
   "main": "./pkg/ridb_core.js",
   "types": "./pkg/ridb_core.d.ts",
   "sideEffects": [

package/pkg/ridb_core.d.ts

@@ -186,70 +186,6 @@ export class BaseStorage<Schemas extends SchemaTypeRecord> extends StorageIntern
 
 
 
-/**
- * Represents an in-memory storage system extending the base storage functionality.
- *
- * @template T - The schema type.
- */
-export 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 an IndexDB storage system extending the base storage functionality.
- *
- * @template T - The schema type.
- */
-export 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 Hook = (
-    schema: Schema<SchemaType>,
-    migration: MigrationPathsForSchema<SchemaType>,
-    doc: Doc<SchemaType>
-) => Doc<SchemaType>
-
-type BasePluginOptions = {
-    docCreateHook?: Hook,
-    docRecoverHook?: Hook
-}
-
-export 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.
@@ -302,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.
      *
@@ -353,38 +291,68 @@ export type RIDBModule = {
 
 
 /**
- * Represents a record of schema types, where each key is a string and the value is a `SchemaType`.
+ * Represents an in-memory storage system extending the base storage functionality.
+ *
+ * @template T - The schema type.
  */
-export type SchemaTypeRecord = {
-    [name: string]: SchemaType
-};
+export class InMemory<T extends SchemaTypeRecord> extends BaseStorage<T> {
+    /**
+     * Frees the resources used by the in-memory storage.
+     */
+    free(): void;
 
-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]>>;
+    static create<SchemasCreate extends SchemaTypeRecord>(
+        dbName: string,
+        schemas: SchemasCreate,
+    ): Promise<
+        InMemory<
+            SchemasCreate
+        >
+    >;
+}
+
+
+
+/**
+ * Represents an IndexDB storage system extending the base storage functionality.
+ *
+ * @template T - The schema type.
+ */
+export 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 Hook = (
+    schema: Schema<SchemaType>,
+    migration: MigrationPathsForSchema<SchemaType>,
+    doc: Doc<SchemaType>
+) => Doc<SchemaType>
+
+type BasePluginOptions = {
+    docCreateHook?: Hook,
+    docRecoverHook?: Hook
 }
 
+export class BasePlugin implements BasePluginOptions {
+     docCreateHook?:Hook;
+     docRecoverHook?:Hook;
+}
+
+
 
 /**
  * Represents the type definition for a schema.
@@ -704,11 +672,59 @@ export class 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 {
+/**
+** Return copy of self without private attributes.
+*/
+  toJSON(): Object;
+/**
+* Return stringified version of self.
+*/
+  toString(): string;
   free(): void;
 /**
+* @param {string} err_type
+* @param {string} message
+* @param {number} code
+*/
+  constructor(err_type: string, message: string, code: number);
+/**
 * @param {any} err
 * @returns {RIDBError}
 */
@@ -857,6 +873,28 @@ export interface InitOutput {
   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_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_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_inmemory_free: (a: number) => void;
   readonly inmemory_create: (a: number, b: number, c: number) => number;
   readonly inmemory_write: (a: number, b: number) => number;
@@ -882,26 +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_ridberror_free: (a: number) => void;
-  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_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_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_schema_free: (a: number) => void;
   readonly schema_validate: (a: number, b: number, c: number) => void;
   readonly schema_is_valid: (a: number, b: number) => void;

package/pkg/ridb_core.js

@@ -409,15 +409,15 @@ export function __wbgtest_console_error(args) {
     }
 }
 
-function __wbg_adapter_294(arg0, arg1) {
+function __wbg_adapter_296(arg0, arg1) {
     wasm.wasm_bindgen__convert__closures__invoke0_mut__hf4bced6426ca6f31(arg0, arg1);
 }
 
-function __wbg_adapter_337(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_388(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.
@@ -1808,6 +1818,18 @@ export class RIDBError {
         return obj;
     }
 
+    toJSON() {
+        return {
+            type: this.type,
+            code: this.code,
+            message: this.message,
+        };
+    }
+
+    toString() {
+        return JSON.stringify(this);
+    }
+
     __destroy_into_raw() {
         const ptr = this.__wbg_ptr;
         this.__wbg_ptr = 0;
@@ -1820,6 +1842,20 @@ export class RIDBError {
         wasm.__wbg_ridberror_free(ptr);
     }
     /**
+    * @param {string} err_type
+    * @param {string} message
+    * @param {number} code
+    */
+    constructor(err_type, message, code) {
+        const ptr0 = passStringToWasm0(err_type, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ptr1 = passStringToWasm0(message, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len1 = WASM_VECTOR_LEN;
+        const ret = wasm.ridberror_new(ptr0, len0, ptr1, len1, code);
+        this.__wbg_ptr = ret >>> 0;
+        return this;
+    }
+    /**
     * @returns {string}
     */
     get type() {
@@ -2677,7 +2713,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_294(a, state0.b, );
+                    return __wbg_adapter_296(a, state0.b, );
                 } finally {
                     state0.a = a;
                 }
@@ -2842,7 +2878,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_337(a, state0.b, arg0, arg1, arg2);
+                    return __wbg_adapter_339(a, state0.b, arg0, arg1, arg2);
                 } finally {
                     state0.a = a;
                 }
@@ -2921,7 +2957,7 @@ function __wbg_get_imports() {
                 const a = state0.a;
                 state0.a = 0;
                 try {
-                    return __wbg_adapter_388(a, state0.b, arg0, arg1);
+                    return __wbg_adapter_390(a, state0.b, arg0, arg1);
                 } finally {
                     state0.a = a;
                 }
@@ -3021,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_wrapper1617 = 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);
     };