harperdb 4.3.18 → 4.3.20

package/resources/IterableEventQueue.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 export declare class IterableEventQueue extends EventEmitter {
     resolveNext: Function;

package/resources/Resource.d.ts

@@ -1,4 +1,4 @@
-import { ResourceInterface, Request, SubscriptionRequest, Id, Context, Query } from './ResourceInterface';
+import { ResourceInterface, SubscriptionRequest, Id, Context, Query } from './ResourceInterface';
 import { Transaction } from './DatabaseTransaction';
 export declare const CONTEXT: unique symbol;
 export declare const ID_PROPERTY: unique symbol;
@@ -20,12 +20,12 @@ export declare class Resource implements ResourceInterface {
     static transactions: Transaction[] & {
         timestamp: number;
     };
+    [CONTEXT]: Context;
     constructor(identifier: Id, source: any);
     /**
      * The get methods are for directly getting a resource, and called for HTTP GET requests.
      */
-    static get(identifier: Id, context?: Context): Promise<object>;
-    static get(request: Request, context?: Context): Promise<object>;
+    static get(identifier: Id, context?: Context): Promise<Resource>;
     static get(query: Query, context?: Context): Promise<AsyncIterable<object>>;
     static get: typeof Resource.get;
     get?(query?: any): Promise<any>;
@@ -33,15 +33,15 @@ export declare class Resource implements ResourceInterface {
      * Store the provided record by the provided id. If no id is provided, it is auto-generated.
      */
     static put: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static patch: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static delete(identifier: Id, context?: Context): Promise<boolean>;
-    static delete(request: Request, context?: Context): Promise<object>;
+    static delete(request: Context, context?: Context): Promise<object>;
     static delete: typeof Resource.delete;
     /**
      * Generate a new primary key for a resource; by default we use UUIDs (for now).
@@ -50,15 +50,15 @@ export declare class Resource implements ResourceInterface {
     static create(id_prefix: Id, record: any, context: Context): Promise<Id>;
     static create(record: any, context: Context): Promise<Id>;
     static invalidate: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static post: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static connect: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static subscribe(request: SubscriptionRequest): Promise<AsyncIterable<{
@@ -68,23 +68,23 @@ export declare class Resource implements ResourceInterface {
     }>>;
     static subscribe: typeof Resource.subscribe;
     static publish: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static search: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static query: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static copy: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static move: {
-        (id_or_query: Id, data_or_context?: any, context?: Context): any;
+        (id_or_query: string | Id, data_or_context?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     post(new_record: any): any;
@@ -99,7 +99,7 @@ export declare class Resource implements ResourceInterface {
      * @param options
      * @returns
      */
-    static getResource(id: Id, request: Request, options?: any): Resource | Promise<Resource>;
+    static getResource(id: Id, request: Context, options?: any): Resource | Promise<Resource>;
     /**
      * This is called by protocols that wish to make a subscription for real-time notification/updates.
      * This default implementation simply provides a streaming iterator that does not deliver any notifications
@@ -126,7 +126,7 @@ export declare class Resource implements ResourceInterface {
      * Get the context for this resource
      * @returns context object with information about the current transaction, user, and more
      */
-    getContext(): any;
+    getContext(): Context;
 }
 export declare function snake_case(camelCase: string): string;
 export declare function transformForSelect(select: any, resource: any): (object: any) => any;

package/resources/ResourceInterface.d.ts

@@ -14,28 +14,71 @@ export interface ResourceInterface<Key = any, Record = any> {
     allowDelete(user: any, query: Query, context: Context): boolean | Promise<boolean>;
 }
 export interface Context {
+    /**	 The user making the request	 */
     user?: any;
+    /**	 The database transaction object	 */
     transaction: DatabaseTransaction;
-    responseData: {
-        lastModified: number;
-    };
+    /**	 If the operation that will be performed with this context should check user authorization	 */
+    authorize?: number;
+    /**	 The last modification time of any data that has been accessed with this context	 */
+    lastModified?: number;
+    /**	 The time	at which a saved record should expire */
+    expiresAt?: number;
+    /**	 Indicates that caching should not be applied	 */
+    noCache?: boolean;
+    /**	 Indicates that values from the source data should be stored as a cached value	 */
+    noCacheStore?: boolean;
+    /**	 Only return values from the table, and don't use data from the source */
+    onlyIfCached?: boolean;
+    /**	 Allows data from a caching table to be used if there is an error retrieving data from the source */
+    staleIfError?: boolean;
+    /**	 Indicates any cached data must be revalidated	 */
+    mustRevalidate?: boolean;
 }
-export interface Request {
-    id?: Id;
-    path?: string;
-    user?: any;
-    data?: any;
-    select?: string[];
-    context?: Context;
+interface DirectCondition {
+    attribute: string;
+    comparator?: string;
+    value: any;
+}
+interface ConditionGroup {
+    conditions: Condition[];
+    operator?: string;
+}
+type Condition = DirectCondition | ConditionGroup;
+interface Sort {
+    attribute: string;
+    descending?: boolean;
+    next?: Sort;
+}
+interface SubSelect {
+    name: string;
+    select: (string | SubSelect)[];
 }
-export interface Query extends Request {
-    conditions?: any[];
+export interface Query {
+    /**	 The conditions to use in the query, that the returned records must satisfy	 */
+    conditions?: Condition[];
+    /**	 The number of records to return	 */
     limit?: number;
+    /**	 The number of records to skip	 */
     offset?: number;
+    /**	 The number of operator to use*/
+    operator?: 'AND' | 'OR';
+    /**	 The sort attribute and direction to use */
+    sort?: Sort;
+    /**	 The selected attributes to return	 */
+    select?: (string | SubSelect)[];
+    /**	 Return an explanation of the query order */
+    explain?: boolean;
+    /**	 Force the query to be executed in the order of conditions */
+    enforceExecutionOrder?: boolean;
 }
-export interface SubscriptionRequest extends Request {
+export interface SubscriptionRequest {
+    /** The starting time of events to return (defaults to now) */
     startTime?: number;
+    /** The count of previously recorded events to return */
     previousCount?: number;
+    /** If the current record state should be omitted as the first event */
+    omitCurrent?: boolean;
 }
 export type Id = number | string | (number | string | null)[] | null;
 type UpdatableRecord<T> = T;

package/resources/auditStore.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 export declare const transactionKeyEncoder: {
     writeKey(key: any, buffer: any, position: any): any;
     readKey(buffer: any, start: any, end: any): any;

package/resources/transaction.d.ts

@@ -0,0 +1,7 @@
+import { Request } from './ResourceInterface';
+export declare function transaction<T>(context: Request, callback: (transaction: TransactionSet) => T, options?: any): T;
+export declare function transaction<T>(callback: (transaction: TransactionSet) => T): T;
+export declare namespace transaction {
+    var commit: (context_source: any) => any;
+    var abort: (context_source: any) => any;
+}

package/server/Server.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { Socket } from 'net';
 /**
  * This is the central interface by which we define entry points for different server protocol plugins to listen for