harperdb 4.6.0-alpha.2 → 4.6.0-alpha.3

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "harperdb",
-	"version": "4.6.0-alpha.2",
+	"version": "4.6.0-alpha.3",
 	"description": "HarperDB is a distributed database, caching service, streaming broker, and application development platform focused on performance and ease of use.",
 	"keywords": [
 		"database",
@@ -87,7 +87,7 @@
 		"minimist": "1.2.8",
 		"moment": "2.30.1",
 		"mqtt-packet": "~9.0.1",
-		"msgpackr": "1.11.2",
+		"msgpackr": "1.11.4",
 		"nats": "2.19.0",
 		"needle": "3.3.1",
 		"node-forge": "^1.3.1",
@@ -119,11 +119,6 @@
 		"ws": "8.18.1",
 		"yaml": "2.7.0"
 	},
-	"overrides": {
-		"alasql": {
-			"xlsx": "0.18.5"
-		}
-	},
 	"optionalDependencies": {
 		"bufferutil": "^4.0.9",
 		"hdd-space": "^1.2.0",

package/resources/RecordEncoder.d.ts

@@ -6,12 +6,22 @@
  */
 import { Encoder } from 'msgpackr';
 import './blob.ts';
+export type Entry = {
+    key: any;
+    value: any;
+    version: number;
+    localTime: number;
+    expiresAt: number;
+    metadataFlags: number;
+    deref?: () => any;
+};
 export declare const TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
 export declare const LAST_TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
 export declare const PREVIOUS_TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
 export declare const NEW_TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
 export declare const LOCAL_TIMESTAMP: unique symbol;
 export declare const METADATA: unique symbol;
+export declare const ENTRY: unique symbol;
 export declare const NO_TIMESTAMP = 0;
 export declare const TIMESTAMP_ASSIGN_NEW = 0;
 export declare const TIMESTAMP_ASSIGN_LAST = 1;
@@ -21,6 +31,7 @@ export declare const HAS_EXPIRATION = 16;
 export declare const HAS_RESIDENCY_ID = 32;
 export declare const PENDING_LOCAL_TIME = 1;
 export declare const HAS_STRUCTURE_UPDATE = 256;
+export declare const entryMap: WeakMap<any, Entry>;
 export declare class RecordEncoder extends Encoder {
     constructor(options: any);
     decode(buffer: any, options: any): any;
@@ -31,3 +42,7 @@ audit?: boolean, // true -> audit this record. false -> do not. null -> retain a
 options?: any, type?: string, resolveRecord?: boolean, // indicates that we are resolving (from source) record that was previously invalidated
 auditRecord?: any) => Promise<void>;
 export declare function removeEntry(store: any, entry: any, existingVersion?: number): any;
+export interface RecordObject {
+    getUpdatedTime(): number;
+    getExpiresAt(): number;
+}

package/resources/RequestTarget.d.ts

@@ -0,0 +1,30 @@
+import { Conditions, Id, Select, Sort } from './ResourceInterface';
+export declare class RequestTarget extends URLSearchParams {
+    target?: string;
+    pathname: string;
+    search?: string;
+    /** Target a specific record, but can be combined with select */
+    id?: Id;
+    /**	 The conditions to use in the query, that the returned records must satisfy	 */
+    conditions?: Conditions;
+    /**	 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 */
+    /** @ts-ignore*/
+    sort?: Sort;
+    /**	 The selected attributes to return	 */
+    select?: Select;
+    /**	 Return an explanation of the query order */
+    explain?: boolean;
+    /**	 Force the query to be executed in the order of conditions */
+    enforceExecutionOrder?: boolean;
+    lazy?: boolean;
+    constructor(target?: string);
+    toString(): string;
+    get url(): string;
+}
+export type RequestTargetOrId = RequestTarget | Id;

package/resources/Resource.d.ts

@@ -1,6 +1,9 @@
 import type { ResourceInterface, SubscriptionRequest, Id, Context, Query } from './ResourceInterface.ts';
-import type { Transaction } from './DatabaseTransaction.ts';
+import { Transaction } from './DatabaseTransaction.ts';
 import { IterableEventQueue } from './IterableEventQueue.ts';
+import { AsyncLocalStorage } from 'async_hooks';
+import { RequestTarget } from './RequestTarget.ts';
+export declare const contextStorage: AsyncLocalStorage<Context>;
 /**
  * This is the main class that can be extended for any resource in HarperDB and provides the essential reusable
  * uniform interface for interacting with data, defining the API for providing data (data sources) and for consuming
@@ -19,23 +22,24 @@ export declare class Resource implements ResourceInterface {
         timestamp: number;
     };
     static directURLMapping: boolean;
+    static loadAsInstance: boolean;
     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<Resource>;
-    static get(query: Query, context?: Context): Promise<AsyncIterable<object>>;
+    static get(target: RequestTarget, context?: Context): Promise<AsyncIterable<object>>;
     static get: typeof Resource.get;
     get?(query?: any): Promise<any>;
     /**
      * Store the provided record by the provided id. If no id is provided, it is auto-generated.
      */
     static put: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static patch: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static delete(identifier: Id, context?: Context): Promise<boolean>;
@@ -55,15 +59,19 @@ export declare class Resource implements ResourceInterface {
     static create(idPrefix: Id, record: any, context: Context): Promise<Id>;
     static create(record: any, context: Context): Promise<Id>;
     static invalidate: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static post: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
+        reliesOnPrototype: boolean;
+    };
+    static update: {
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static connect: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static subscribe(request: SubscriptionRequest): Promise<AsyncIterable<{
@@ -73,30 +81,30 @@ export declare class Resource implements ResourceInterface {
     }>>;
     static subscribe: typeof Resource.subscribe;
     static publish: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static search: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static query: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static copy: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     static move: {
-        (idOrQuery: string | Id, dataOrContext?: any, context?: Context): any;
+        (idOrQuery: string | Id | Query, dataOrContext?: any, context?: Context): any;
         reliesOnPrototype: boolean;
     };
     post(newRecord: any): Promise<any>;
     static isCollection(resource: any): any;
     get isCollection(): boolean;
     static coerceId(id: string): number | string;
-    static parseQuery(search: any): any;
+    static parseQuery(search: any, query: any): URLSearchParams | RequestTarget;
     static parsePath(path: any, context: any, query: any): any;
     /**
      * Gets an instance of a resource by id

package/resources/ResourceInterface.d.ts

@@ -1,18 +1,21 @@
 import { DatabaseTransaction } from './DatabaseTransaction.ts';
 import { OperationFunctionName } from '../server/serverHelpers/serverUtilities.ts';
+import { RequestTarget } from './RequestTarget';
 export interface ResourceInterface<Key = any, Record = any> {
-    get?(): Promise<UpdatableRecord<Record>>;
-    get?(query: Query): Promise<AsyncIterable<Record>>;
-    get?(property: string): any;
-    put?(record: any): void;
+    get?(id: Id): Promise<UpdatableRecord<Record>>;
+    get?(query: RequestTargetOrId): Promise<AsyncIterable<Record>>;
+    put?(target: RequestTargetOrId, record: any): void;
+    post?(target: RequestTargetOrId, record: any): void;
+    patch?(target: RequestTargetOrId, record: any): void;
+    publish?(target: RequestTargetOrId, record: any): void;
     update?(updates: any, fullUpdate?: boolean): Promise<UpdatableRecord<Record>>;
-    delete?(): boolean;
-    search?(query: Query): AsyncIterable<any>;
+    delete?(target: RequestTargetOrId): boolean;
+    search?(query: RequestTarget): AsyncIterable<any>;
     subscribe?(request: SubscriptionRequest): Subscription;
-    allowRead(user: any, query?: Query, context: Context): boolean | Promise<boolean>;
+    allowRead(user: any, target: RequestTarget, context: Context): boolean | Promise<boolean>;
     allowUpdate(user: any, record: any, fullUpdate?: boolean): boolean | Promise<boolean>;
     allowCreate(user: any, record: any, context: Context): boolean | Promise<boolean>;
-    allowDelete(user: any, query: Query, context: Context): boolean | Promise<boolean>;
+    allowDelete(user: any, target: RequestTarget, context: Context): boolean | Promise<boolean>;
 }
 export interface User {
     username: string;
@@ -43,6 +46,10 @@ export interface Context {
     replicateFrom?: boolean;
     replicatedConfirmation?: number;
     originatingOperation?: OperationFunctionName;
+    previousResidency?: string[];
+    loadedFromSource?: boolean;
+    nodeName?: string;
+    resourceCache?: Map<Id, any>;
 }
 export type Operator = 'and' | 'or';
 type SearchType = 'equals' | 'contains' | 'starts_with' | 'ends_with' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'between';
@@ -70,27 +77,6 @@ export interface SubSelect {
     select: (string | SubSelect)[];
 }
 export type Select = (string | SubSelect)[];
-export interface Query {
-    /** Retrieve a specific record, but can be combined with select */
-    id?: Id;
-    /**	 The conditions to use in the query, that the returned records must satisfy	 */
-    conditions?: Conditions;
-    /**	 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?: Select;
-    /**	 Return an explanation of the query order */
-    explain?: boolean;
-    /**	 Force the query to be executed in the order of conditions */
-    enforceExecutionOrder?: boolean;
-    lazy?: boolean;
-}
 export interface SubscriptionRequest {
     /** The starting time of events to return (defaults to now) */
     startTime?: number;
@@ -98,7 +84,14 @@ export interface SubscriptionRequest {
     previousCount?: number;
     /** If the current record state should be omitted as the first event */
     omitCurrent?: boolean;
+    onlyChildren?: boolean;
+    includeDescendants?: boolean;
+    supportsTransactions?: boolean;
+    rawEvents?: boolean;
+    listener: (data: any) => void;
 }
+export type Query = RequestTarget;
+export type RequestTargetOrId = RequestTarget | Id;
 export type Id = number | string | (number | string | null)[] | null;
 type UpdatableRecord<T> = T;
 interface Subscription {