harperdb 4.5.9 → 4.6.0-alpha.2

package/resources/Table.d.ts

@@ -3,9 +3,9 @@
  * tables through the interface defined by the Resource class. This module is responsible for handling these
  * table-level interactions, loading records, updating records, querying, and more.
  */
-import { Database } from 'lmdb';
-import type { Query, ResourceInterface, SubscriptionRequest, Id, Context, Sort, SubSelect } from './ResourceInterface';
-import { Resource } from './Resource';
+import { type Database } from 'lmdb';
+import type { Query, ResourceInterface, SubscriptionRequest, Id, Context, Sort, SubSelect } from './ResourceInterface.ts';
+import { Resource } from './Resource.ts';
 type Attribute = {
     name: string;
     type: string;
@@ -75,16 +75,16 @@ export declare function makeTable(options: any): {
         /**
          * Determine if the user is allowed to update data from the current resource
          * @param user The current, authenticated user
-         * @param updated_data
-         * @param full_update
+         * @param updatedData
+         * @param fullUpdate
          */
-        allowUpdate(user: any, updated_data: any): boolean;
+        allowUpdate(user: any, updatedData: any): boolean;
         /**
          * Determine if the user is allowed to create new data in the current resource
          * @param user The current, authenticated user
-         * @param new_data
+         * @param newData
          */
-        allowCreate(user: any, new_data: {}): boolean;
+        allowCreate(user: any, newData: {}): boolean;
         /**
          * Determine if the user is allowed to delete from the current resource
          * @param user The current, authenticated user
@@ -94,9 +94,9 @@ export declare function makeTable(options: any): {
          * Start updating a record. The returned resource will record changes which are written
          * once the corresponding transaction is committed. These changes can (eventually) include CRDT type operations.
          * @param updates This can be a record to update the current resource with.
-         * @param full_update The provided data in updates is the full intended record; any properties in the existing record that are not in the updates, should be removed
+         * @param fullUpdate The provided data in updates is the full intended record; any properties in the existing record that are not in the updates, should be removed
          */
-        update(updates?: any, full_update?: boolean): /*elided*/ any;
+        update(updates?: any, fullUpdate?: boolean): /*elided*/ any;
         addTo(property: any, value: any): void;
         subtractFrom(property: any, value: any): void;
         getMetadata(): Entry;
@@ -105,7 +105,7 @@ export declare function makeTable(options: any): {
         _setChanges(changes: any): void;
         setRecord(record: any): void;
         invalidate(): void;
-        _writeInvalidate(partial_record?: any, options?: any): void;
+        _writeInvalidate(partialRecord?: any, options?: any): void;
         _writeRelocate(options: any): void;
         /**
          * This is intended to acquire a lock on a record from the whole cluster.
@@ -120,8 +120,8 @@ export declare function makeTable(options: any): {
          * @param options
          */
         put(record: any): void;
-        patch(record_update: any): void;
-        _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
+        patch(recordUpdate: any): void;
+        _writeUpdate(recordUpdate: any, fullUpdate: boolean, options?: any): void;
         delete(request?: Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: Query): AsyncIterable<any>;
@@ -142,9 +142,9 @@ export declare function makeTable(options: any): {
             send(message: any): void;
             getNextMessage(): any;
             waitForDrain(): Promise<boolean>;
-            on(event_name: any, listener: any): /*elided*/ any;
+            on(eventName: any, listener: any): /*elided*/ any;
             [Symbol.asyncIterator](): {
-                queue: import("./IterableEventQueue").IterableEventQueue;
+                queue: import("./IterableEventQueue.js").IterableEventQueue;
                 push(message: any): void;
                 next(): Promise<unknown> | {
                     value: any;
@@ -189,9 +189,9 @@ export declare function makeTable(options: any): {
         readonly "__#6@#id": Id;
         readonly "__#6@#context": Context;
         "__#6@#isCollection": boolean;
-        post(new_record: any): Promise<any>;
+        post(newRecord: any): Promise<any>;
         readonly isCollection: boolean;
-        connect(incomingMessages: import("./IterableEventQueue").IterableEventQueue, query?: {}): AsyncIterable<any>;
+        connect(incomingMessages: import("./IterableEventQueue.js").IterableEventQueue, query?: {}): AsyncIterable<any>;
         getId(): Id;
         getContext(): Context;
     };
@@ -239,7 +239,7 @@ export declare function makeTable(options: any): {
      * @param options An important option is ensureLoaded, which can be used to indicate that it is necessary for a caching table to load data from the source if there is not a local copy of the data in the table (usually not necessary for a delete, for example).
      * @returns
      */
-    getResource(id: Id, request: Context, resource_options?: any): Promise<{
+    getResource(id: Id, request: Context, resourceOptions?: any): Promise<{
         "__#5@#record": any;
         "__#5@#changes": any;
         "__#5@#version": number;
@@ -266,16 +266,16 @@ export declare function makeTable(options: any): {
         /**
          * Determine if the user is allowed to update data from the current resource
          * @param user The current, authenticated user
-         * @param updated_data
-         * @param full_update
+         * @param updatedData
+         * @param fullUpdate
          */
-        allowUpdate(user: any, updated_data: any): boolean;
+        allowUpdate(user: any, updatedData: any): boolean;
         /**
          * Determine if the user is allowed to create new data in the current resource
          * @param user The current, authenticated user
-         * @param new_data
+         * @param newData
          */
-        allowCreate(user: any, new_data: {}): boolean;
+        allowCreate(user: any, newData: {}): boolean;
         /**
          * Determine if the user is allowed to delete from the current resource
          * @param user The current, authenticated user
@@ -285,9 +285,9 @@ export declare function makeTable(options: any): {
          * Start updating a record. The returned resource will record changes which are written
          * once the corresponding transaction is committed. These changes can (eventually) include CRDT type operations.
          * @param updates This can be a record to update the current resource with.
-         * @param full_update The provided data in updates is the full intended record; any properties in the existing record that are not in the updates, should be removed
+         * @param fullUpdate The provided data in updates is the full intended record; any properties in the existing record that are not in the updates, should be removed
          */
-        update(updates?: any, full_update?: boolean): /*elided*/ any;
+        update(updates?: any, fullUpdate?: boolean): /*elided*/ any;
         addTo(property: any, value: any): void;
         subtractFrom(property: any, value: any): void;
         getMetadata(): Entry;
@@ -296,7 +296,7 @@ export declare function makeTable(options: any): {
         _setChanges(changes: any): void;
         setRecord(record: any): void;
         invalidate(): void;
-        _writeInvalidate(partial_record?: any, options?: any): void;
+        _writeInvalidate(partialRecord?: any, options?: any): void;
         _writeRelocate(options: any): void;
         /**
          * This is intended to acquire a lock on a record from the whole cluster.
@@ -311,8 +311,8 @@ export declare function makeTable(options: any): {
          * @param options
          */
         put(record: any): void;
-        patch(record_update: any): void;
-        _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
+        patch(recordUpdate: any): void;
+        _writeUpdate(recordUpdate: any, fullUpdate: boolean, options?: any): void;
         delete(request?: Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: Query): AsyncIterable<any>;
@@ -333,9 +333,9 @@ export declare function makeTable(options: any): {
             send(message: any): void;
             getNextMessage(): any;
             waitForDrain(): Promise<boolean>;
-            on(event_name: any, listener: any): /*elided*/ any;
+            on(eventName: any, listener: any): /*elided*/ any;
             [Symbol.asyncIterator](): {
-                queue: import("./IterableEventQueue").IterableEventQueue;
+                queue: import("./IterableEventQueue.js").IterableEventQueue;
                 push(message: any): void;
                 next(): Promise<unknown> | {
                     value: any;
@@ -380,9 +380,9 @@ export declare function makeTable(options: any): {
         readonly "__#6@#id": Id;
         readonly "__#6@#context": Context;
         "__#6@#isCollection": boolean;
-        post(new_record: any): Promise<any>;
+        post(newRecord: any): Promise<any>;
         readonly isCollection: boolean;
-        connect(incomingMessages: import("./IterableEventQueue").IterableEventQueue, query?: {}): AsyncIterable<any>;
+        connect(incomingMessages: import("./IterableEventQueue.js").IterableEventQueue, query?: {}): AsyncIterable<any>;
         getId(): Id;
         getContext(): Context;
     }> | {
@@ -412,16 +412,16 @@ export declare function makeTable(options: any): {
         /**
          * Determine if the user is allowed to update data from the current resource
          * @param user The current, authenticated user
-         * @param updated_data
-         * @param full_update
+         * @param updatedData
+         * @param fullUpdate
          */
-        allowUpdate(user: any, updated_data: any): boolean;
+        allowUpdate(user: any, updatedData: any): boolean;
         /**
          * Determine if the user is allowed to create new data in the current resource
          * @param user The current, authenticated user
-         * @param new_data
+         * @param newData
          */
-        allowCreate(user: any, new_data: {}): boolean;
+        allowCreate(user: any, newData: {}): boolean;
         /**
          * Determine if the user is allowed to delete from the current resource
          * @param user The current, authenticated user
@@ -431,9 +431,9 @@ export declare function makeTable(options: any): {
          * Start updating a record. The returned resource will record changes which are written
          * once the corresponding transaction is committed. These changes can (eventually) include CRDT type operations.
          * @param updates This can be a record to update the current resource with.
-         * @param full_update The provided data in updates is the full intended record; any properties in the existing record that are not in the updates, should be removed
+         * @param fullUpdate The provided data in updates is the full intended record; any properties in the existing record that are not in the updates, should be removed
          */
-        update(updates?: any, full_update?: boolean): /*elided*/ any;
+        update(updates?: any, fullUpdate?: boolean): /*elided*/ any;
         addTo(property: any, value: any): void;
         subtractFrom(property: any, value: any): void;
         getMetadata(): Entry;
@@ -442,7 +442,7 @@ export declare function makeTable(options: any): {
         _setChanges(changes: any): void;
         setRecord(record: any): void;
         invalidate(): void;
-        _writeInvalidate(partial_record?: any, options?: any): void;
+        _writeInvalidate(partialRecord?: any, options?: any): void;
         _writeRelocate(options: any): void;
         /**
          * This is intended to acquire a lock on a record from the whole cluster.
@@ -457,8 +457,8 @@ export declare function makeTable(options: any): {
          * @param options
          */
         put(record: any): void;
-        patch(record_update: any): void;
-        _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
+        patch(recordUpdate: any): void;
+        _writeUpdate(recordUpdate: any, fullUpdate: boolean, options?: any): void;
         delete(request?: Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: Query): AsyncIterable<any>;
@@ -479,9 +479,9 @@ export declare function makeTable(options: any): {
             send(message: any): void;
             getNextMessage(): any;
             waitForDrain(): Promise<boolean>;
-            on(event_name: any, listener: any): /*elided*/ any;
+            on(eventName: any, listener: any): /*elided*/ any;
             [Symbol.asyncIterator](): {
-                queue: import("./IterableEventQueue").IterableEventQueue;
+                queue: import("./IterableEventQueue.js").IterableEventQueue;
                 push(message: any): void;
                 next(): Promise<unknown> | {
                     value: any;
@@ -526,9 +526,9 @@ export declare function makeTable(options: any): {
         readonly "__#6@#id": Id;
         readonly "__#6@#context": Context;
         "__#6@#isCollection": boolean;
-        post(new_record: any): Promise<any>;
+        post(newRecord: any): Promise<any>;
         readonly isCollection: boolean;
-        connect(incomingMessages: import("./IterableEventQueue").IterableEventQueue, query?: {}): AsyncIterable<any>;
+        connect(incomingMessages: import("./IterableEventQueue.js").IterableEventQueue, query?: {}): AsyncIterable<any>;
         getId(): Id;
         getContext(): Context;
     };
@@ -537,8 +537,8 @@ export declare function makeTable(options: any): {
     /**
      * Set TTL expiration for records in this table. On retrieval, record timestamps are checked for expiration.
      * This also informs the scheduling for record eviction.
-     * @param expiration_time Time in seconds until records expire (are stale)
-     * @param eviction_time Time in seconds until records are evicted (removed)
+     * @param expirationTime Time in seconds until records expire (are stale)
+     * @param evictionTime Time in seconds until records are evicted (removed)
      */
     setTTLExpiration(expiration: number | {
         expiration: number;
@@ -552,7 +552,7 @@ export declare function makeTable(options: any): {
     /**
      * Turn on auditing at runtime
      */
-    enableAuditing(audit_enabled?: boolean): void;
+    enableAuditing(auditEnabled?: boolean): void;
     /**
      * Coerce the id as a string to the correct type for the primary key
      * @param id
@@ -562,14 +562,14 @@ export declare function makeTable(options: any): {
     dropTable(): Promise<void>;
     /**
      * Record the relocation of an entry (when a record is moved to a different node)
-     * @param existing_entry
+     * @param existingEntry
      * @param entry
      */
-    _recordRelocate(existing_entry: any, entry: any): void;
+    _recordRelocate(existingEntry: any, entry: any): void;
     /**
      * Evicting a record will remove it from a caching table. This is not considered a canonical data change, and it is assumed that retrieving this record from the source will still yield the same record, this is only removing the local copy of the record.
      */
-    evict(id: any, existing_record: any, existing_version: any): Promise<void>;
+    evict(id: any, existingRecord: any, existingVersion: any): Promise<void>;
     operation(operation: any, context: any): any;
     /**
      * This is responsible for ordering and select()ing the attributes/properties from returned entries
@@ -577,27 +577,27 @@ export declare function makeTable(options: any): {
      * @param context
      * @param filtered
      * @param ensure_loaded
-     * @param can_skip
+     * @param canSkip
      * @returns
      */
-    transformToOrderedSelect(entries: any[], select: (string | SubSelect)[], sort: Sort, context: Context, read_txn: any, transformToRecord: Function): any;
+    transformToOrderedSelect(entries: any[], select: (string | SubSelect)[], sort: Sort, context: Context, readTxn: any, transformToRecord: Function): any;
     /**
      * This is responsible for select()ing the attributes/properties from returned entries
      * @param select
      * @param context
      * @param filtered
      * @param ensure_loaded
-     * @param can_skip
+     * @param canSkip
      * @returns
      */
-    transformEntryForSelect(select: any, context: any, read_txn: any, filtered: any, ensure_loaded?: any, can_skip?: any): (entry: any) => any;
+    transformEntryForSelect(select: any, context: any, readTxn: any, filtered: any, ensure_loaded?: any, canSkip?: any): (entry: any) => any;
     /**
      * Subscribe on one thread unless this is a per-thread subscription
-     * @param worker_index
+     * @param workerIndex
      * @param options
      */
-    subscribeOnThisThread(worker_index: any, options: any): boolean;
-    addAttributes(attributes_to_add: any): Promise<any>;
+    subscribeOnThisThread(workerIndex: any, options: any): boolean;
+    addAttributes(attributesToAdd: any): Promise<any>;
     removeAttributes(names: string[]): Promise<any>;
     /**
      * Get the size of the table in bytes (based on amount of pages stored in the database)
@@ -622,8 +622,8 @@ export declare function makeTable(options: any): {
      */
     updatedAttributes(): void;
     setComputedAttribute(attribute_name: any, resolver: any): void;
-    deleteHistory(end_time?: number, cleanup_deleted_records?: boolean): Promise<void>;
-    getHistory(start_time?: number, end_time?: number): AsyncGenerator<{
+    deleteHistory(endTime?: number, cleanupDeletedRecords?: boolean): Promise<void>;
+    getHistory(startTime?: number, endTime?: number): AsyncGenerator<{
         id: import("ordered-binary").Key;
         localTime: any;
         version: any;
@@ -634,34 +634,34 @@ export declare function makeTable(options: any): {
     }, void, unknown>;
     getHistoryOfRecord(id: any): Promise<any[]>;
     cleanup(): void;
-    transactions: import("./DatabaseTransaction").Transaction[] & {
+    transactions: import("./DatabaseTransaction.ts").Transaction[] & {
         timestamp: number;
     };
     directURLMapping: boolean;
     get(identifier: Id, context?: Context): Promise<Resource>;
     get(query: Query, context?: Context): Promise<AsyncIterable<object>>;
     put: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     patch: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     delete(identifier: Id, context?: Context): Promise<boolean>;
     delete(request: Context, context?: Context): Promise<object>;
-    create(id_prefix: Id, record: any, context: Context): Promise<Id>;
+    create(idPrefix: Id, record: any, context: Context): Promise<Id>;
     create(record: any, context: Context): Promise<Id>;
     invalidate: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     post: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     connect: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     subscribe(request: SubscriptionRequest): Promise<AsyncIterable<{
@@ -670,23 +670,23 @@ export declare function makeTable(options: any): {
         value: object;
     }>>;
     publish: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     search: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     query: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     copy: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     move: {
-        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
+        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     isCollection(resource: any): any;