harperdb 4.3.19 → 4.3.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "harperdb",
-  "version": "4.3.19",
+  "version": "4.3.21",
   "description": "HarperDB is a distributed database, caching service, streaming broker, and application development platform focused on performance and ease of use.",
   "keywords": [
     "database",
@@ -10,10 +10,18 @@
     "broker",
     "mqtt",
     "real-time",
-    "cloud",
     "enterprise",
     "Fastify",
-    "NATS"
+    "NATS",
+    "HarperDB",
+    "Harper",
+    "clustering",
+    "replication",
+    "REST",
+    "WebSockets",
+    "decentralized",
+    "server-sent events",
+    "document store"
   ],
   "main": "harperdb.js",
   "bin": {
@@ -35,8 +43,8 @@
   },
   "license": "SEE LICENSE IN LICENSE",
   "dependencies": {
-    "@aws-sdk/client-s3": "3.535.0",
-    "@aws-sdk/lib-storage": "3.535.0",
+    "@aws-sdk/client-s3": "3.635.0",
+    "@aws-sdk/lib-storage": "3.635.0",
     "@endo/static-module-record": "^1.0.4",
     "@fastify/autoload": "5.7.1",
     "@fastify/compress": "~6.5.0",
@@ -69,7 +77,7 @@
     "json2csv": "5.0.7",
     "jsonata": "1.8.7",
     "jsonwebtoken": "9.0.2",
-    "lmdb": "3.0.12",
+    "lmdb": "3.0.14",
     "lodash": "4.17.21",
     "mathjs": "11.12.0",
     "minimist": "1.2.8",
@@ -89,7 +97,7 @@
     "passport-http": "0.3.0",
     "passport-local": "1.0.0",
     "pino": "8.16.0",
-    "pm2": "5.3.1",
+    "pm2": "5.4.1",
     "prompt": "1.3.0",
     "properties-reader": "2.3.0",
     "recursive-iterator": "3.3.0",
@@ -104,7 +112,7 @@
     "ulidx": "0.5.0",
     "uuid": "9.0.1",
     "validate.js": "0.13.1",
-    "ws": "8.16.0",
+    "ws": "8.17.1",
     "yaml": "2.4.1"
   },
   "overrides": {

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;
@@ -24,8 +24,7 @@ export declare class Resource implements ResourceInterface {
     /**
      * 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>;
@@ -41,7 +40,7 @@ export declare class Resource implements ResourceInterface {
         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).
@@ -99,7 +98,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 +125,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/Table.d.ts

@@ -4,7 +4,8 @@
  * table-level interactions, loading records, updating records, querying, and more.
  */
 import { Database } from 'lmdb';
-import { Query, ResourceInterface, Request, SubscriptionRequest, Id, Context } from './ResourceInterface';
+import { Query, ResourceInterface, SubscriptionRequest, Id, Context } from './ResourceInterface';
+import { Resource } from './Resource';
 export interface Table {
     primaryStore: Database;
     auditStore: Database;
@@ -90,7 +91,7 @@ export declare function makeTable(options: any): {
         put(record: any): void;
         patch(record_update: any): void;
         _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
-        delete(request: Request): Promise<boolean>;
+        delete(request?: Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: Query): AsyncIterable<any>;
         subscribe(request: SubscriptionRequest): Promise<{
@@ -130,13 +131,13 @@ export declare function makeTable(options: any): {
             removeAllListeners(eventName?: string | symbol): any;
             setMaxListeners(n: number): any;
             getMaxListeners(): number;
-            listeners<K>(eventName: string | symbol): Array<Function>;
-            rawListeners<K>(eventName: string | symbol): Array<Function>;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
             emit<K>(eventName: string | symbol, ...args: any[]): boolean;
             listenerCount<K>(eventName: string | symbol, listener?: Function): number;
             prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
             prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-            eventNames(): Array<(string | symbol) & (string | symbol)>;
+            eventNames(): (string | symbol)[];
         }>;
         doesExist(): boolean;
         /**
@@ -154,7 +155,7 @@ export declare function makeTable(options: any): {
         post(new_record: any): any;
         connect(query?: {}): AsyncIterable<any>;
         getId(): any;
-        getContext(): any;
+        getContext(): Context;
     };
     name: any;
     primaryStore: any;
@@ -253,7 +254,7 @@ export declare function makeTable(options: any): {
         put(record: any): void;
         patch(record_update: any): void;
         _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
-        delete(request: Request): Promise<boolean>;
+        delete(request?: Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: Query): AsyncIterable<any>;
         subscribe(request: SubscriptionRequest): Promise<{
@@ -293,13 +294,13 @@ export declare function makeTable(options: any): {
             removeAllListeners(eventName?: string | symbol): any;
             setMaxListeners(n: number): any;
             getMaxListeners(): number;
-            listeners<K>(eventName: string | symbol): Array<Function>;
-            rawListeners<K>(eventName: string | symbol): Array<Function>;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
             emit<K>(eventName: string | symbol, ...args: any[]): boolean;
             listenerCount<K>(eventName: string | symbol, listener?: Function): number;
             prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
             prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-            eventNames(): Array<(string | symbol) & (string | symbol)>;
+            eventNames(): (string | symbol)[];
         }>;
         doesExist(): boolean;
         /**
@@ -317,7 +318,7 @@ export declare function makeTable(options: any): {
         post(new_record: any): any;
         connect(query?: {}): AsyncIterable<any>;
         getId(): any;
-        getContext(): any;
+        getContext(): Context;
     }> | {
         /**
          * This is a request to explicitly ensure that the record is loaded from source, rather than only using the local record.
@@ -380,7 +381,7 @@ export declare function makeTable(options: any): {
         put(record: any): void;
         patch(record_update: any): void;
         _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
-        delete(request: Request): Promise<boolean>;
+        delete(request?: Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: Query): AsyncIterable<any>;
         subscribe(request: SubscriptionRequest): Promise<{
@@ -420,13 +421,13 @@ export declare function makeTable(options: any): {
             removeAllListeners(eventName?: string | symbol): any;
             setMaxListeners(n: number): any;
             getMaxListeners(): number;
-            listeners<K>(eventName: string | symbol): Array<Function>;
-            rawListeners<K>(eventName: string | symbol): Array<Function>;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
             emit<K>(eventName: string | symbol, ...args: any[]): boolean;
             listenerCount<K>(eventName: string | symbol, listener?: Function): number;
             prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
             prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-            eventNames(): Array<(string | symbol) & (string | symbol)>;
+            eventNames(): (string | symbol)[];
         }>;
         doesExist(): boolean;
         /**
@@ -444,7 +445,7 @@ export declare function makeTable(options: any): {
         post(new_record: any): any;
         connect(query?: {}): AsyncIterable<any>;
         getId(): any;
-        getContext(): any;
+        getContext(): Context;
     };
     /**
      * Set TTL expiration for records in this table. On retrieval, record timestamps are checked for expiration.
@@ -520,8 +521,7 @@ export declare function makeTable(options: any): {
     transactions: import("./DatabaseTransaction").Transaction[] & {
         timestamp: number;
     };
-    get(identifier: Id, context?: Context): Promise<object>;
-    get(request: Request, context?: Context): Promise<object>;
+    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;
@@ -532,7 +532,7 @@ export declare function makeTable(options: any): {
         reliesOnPrototype: boolean;
     };
     delete(identifier: Id, context?: Context): Promise<boolean>;
-    delete(request: Request, context?: Context): Promise<object>;
+    delete(request: Context, context?: Context): Promise<object>;
     getNewId(): `${string}-${string}-${string}-${string}-${string}`;
     create(id_prefix: Id, record: any, context: Context): Promise<Id>;
     create(record: any, context: Context): Promise<Id>;

package/resources/databases.d.ts

@@ -87,7 +87,7 @@ export declare function table({ table: table_name, database: database_name, expi
         put(record: any): void;
         patch(record_update: any): void;
         _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
-        delete(request: import("./ResourceInterface").Request): Promise<boolean>;
+        delete(request?: import("./ResourceInterface").Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: import("./ResourceInterface").Query): AsyncIterable<any>;
         subscribe(request: import("./ResourceInterface").SubscriptionRequest): Promise<{
@@ -127,13 +127,13 @@ export declare function table({ table: table_name, database: database_name, expi
             removeAllListeners(eventName?: string | symbol): any;
             setMaxListeners(n: number): any;
             getMaxListeners(): number;
-            listeners<K>(eventName: string | symbol): Array<Function>;
-            rawListeners<K>(eventName: string | symbol): Array<Function>;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
             emit<K>(eventName: string | symbol, ...args: any[]): boolean;
             listenerCount<K>(eventName: string | symbol, listener?: Function): number;
             prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
             prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-            eventNames(): Array<(string | symbol) & (string | symbol)>;
+            eventNames(): (string | symbol)[];
         }>;
         doesExist(): boolean;
         publish(message: any, options?: any): void;
@@ -144,7 +144,7 @@ export declare function table({ table: table_name, database: database_name, expi
         post(new_record: any): any;
         connect(query?: {}): AsyncIterable<any>;
         getId(): any;
-        getContext(): any;
+        getContext(): import("./ResourceInterface").Context;
     };
     name: any;
     primaryStore: any;
@@ -181,7 +181,7 @@ export declare function table({ table: table_name, database: database_name, expi
         put(record: any): void;
         patch(record_update: any): void;
         _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
-        delete(request: import("./ResourceInterface").Request): Promise<boolean>;
+        delete(request?: import("./ResourceInterface").Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: import("./ResourceInterface").Query): AsyncIterable<any>;
         subscribe(request: import("./ResourceInterface").SubscriptionRequest): Promise<{
@@ -221,13 +221,13 @@ export declare function table({ table: table_name, database: database_name, expi
             removeAllListeners(eventName?: string | symbol): any;
             setMaxListeners(n: number): any;
             getMaxListeners(): number;
-            listeners<K>(eventName: string | symbol): Array<Function>;
-            rawListeners<K>(eventName: string | symbol): Array<Function>;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
             emit<K>(eventName: string | symbol, ...args: any[]): boolean;
             listenerCount<K>(eventName: string | symbol, listener?: Function): number;
             prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
             prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-            eventNames(): Array<(string | symbol) & (string | symbol)>;
+            eventNames(): (string | symbol)[];
         }>;
         doesExist(): boolean;
         publish(message: any, options?: any): void;
@@ -238,7 +238,7 @@ export declare function table({ table: table_name, database: database_name, expi
         post(new_record: any): any;
         connect(query?: {}): AsyncIterable<any>;
         getId(): any;
-        getContext(): any;
+        getContext(): import("./ResourceInterface").Context;
     }> | {
         ensureLoaded(): any;
         get(query?: import("./ResourceInterface").Query | string): Promise<object | void> | object | void;
@@ -255,7 +255,7 @@ export declare function table({ table: table_name, database: database_name, expi
         put(record: any): void;
         patch(record_update: any): void;
         _writeUpdate(record_update: any, full_update: boolean, options?: any): void;
-        delete(request: import("./ResourceInterface").Request): Promise<boolean>;
+        delete(request?: import("./ResourceInterface").Query | string): Promise<boolean>;
         _writeDelete(options?: any): boolean;
         search(request: import("./ResourceInterface").Query): AsyncIterable<any>;
         subscribe(request: import("./ResourceInterface").SubscriptionRequest): Promise<{
@@ -295,13 +295,13 @@ export declare function table({ table: table_name, database: database_name, expi
             removeAllListeners(eventName?: string | symbol): any;
             setMaxListeners(n: number): any;
             getMaxListeners(): number;
-            listeners<K>(eventName: string | symbol): Array<Function>;
-            rawListeners<K>(eventName: string | symbol): Array<Function>;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
             emit<K>(eventName: string | symbol, ...args: any[]): boolean;
             listenerCount<K>(eventName: string | symbol, listener?: Function): number;
             prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
             prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-            eventNames(): Array<(string | symbol) & (string | symbol)>;
+            eventNames(): (string | symbol)[];
         }>;
         doesExist(): boolean;
         publish(message: any, options?: any): void;
@@ -312,7 +312,7 @@ export declare function table({ table: table_name, database: database_name, expi
         post(new_record: any): any;
         connect(query?: {}): AsyncIterable<any>;
         getId(): any;
-        getContext(): any;
+        getContext(): import("./ResourceInterface").Context;
     };
     setTTLExpiration(expiration: number | {
         expiration: number;
@@ -350,8 +350,7 @@ export declare function table({ table: table_name, database: database_name, expi
     transactions: import("./DatabaseTransaction").Transaction[] & {
         timestamp: number;
     };
-    get(identifier: import("./ResourceInterface").Id, context?: import("./ResourceInterface").Context): Promise<object>;
-    get(request: import("./ResourceInterface").Request, context?: import("./ResourceInterface").Context): Promise<object>;
+    get(identifier: import("./ResourceInterface").Id, context?: import("./ResourceInterface").Context): Promise<import("./Resource").Resource>;
     get(query: import("./ResourceInterface").Query, context?: import("./ResourceInterface").Context): Promise<AsyncIterable<object>>;
     put: {
         (id_or_query: string | import("./ResourceInterface").Id, data_or_context?: any, context?: import("./ResourceInterface").Context): any;
@@ -362,7 +361,7 @@ export declare function table({ table: table_name, database: database_name, expi
         reliesOnPrototype: boolean;
     };
     delete(identifier: import("./ResourceInterface").Id, context?: import("./ResourceInterface").Context): Promise<boolean>;
-    delete(request: import("./ResourceInterface").Request, context?: import("./ResourceInterface").Context): Promise<object>;
+    delete(request: import("./ResourceInterface").Context, context?: import("./ResourceInterface").Context): Promise<object>;
     getNewId(): `${string}-${string}-${string}-${string}-${string}`;
     create(id_prefix: import("./ResourceInterface").Id, record: any, context: import("./ResourceInterface").Context): Promise<import("./ResourceInterface").Id>;
     create(record: any, context: import("./ResourceInterface").Context): Promise<import("./ResourceInterface").Id>;